How I structure and organize my reactjs components
React is all about components. Better structure helps you to easily debug your app, and understand how the flow is going on, and also as your project grows it becomes easy to manage everything. Now, React doesn't care how you structure your project and components. So in this blog, I am going to share how I structure my project and its components.
Let's get started
Before we start
- In this article, I don't use any styling framework just plain CSS(sass).
- Also plain react π .
File structure
If you like this structure you can download it from here.
Apart from configurations actual react project starts from the src/
folder. So let's directly jump into it.
βββ src/ βββ app/ βββ assets/ β βββ images/ βββ common/ β βββ Footer/ β β βββ components β βββ Hooks/ β βββ Navigation/ β β βββ components β βββ UIElements/ β β βββ LoadingAnimations/ β βββ Util/ βββ pages/ β βββ 404/ β βββ About/ β β βββ components/ β β βββ About.jsx β βββ Contact/ β β βββ components/ β β βββ Contact.jsx β βββ Home/ β βββ components/ β βββ Home.jsx βββ styles/ βββ _mixins.scss βββ _variables.scss
I always separate client and server logic even for a small project because it helps to focus on one thing and it makes the project less messy.
Quickly know what each folder contains:
- app/ - This folder contains actual react app.
- common/ - This folder contains components that can be used anywhere in the project.
- pages/ - This folder contains all the common pages of the website.
- assets/ - All the assets like images, audios etc.
- styles/ - This folder contains global styles like Sass variables, mixins, functions etc.
Let's dig deep
Pages
. βββ pages/ βββ components/ β βββ Hero.jsx β βββ Hero.scss β βββ CTA.jsx β βββ CTS.scss βββ Home.jsx
So, here Home.jsx
is a route and page. The idea is to imagine each page as a separate HTML file and it contains different sections as components.
Common
. βββ common/ βββ Footer/ βββ Hooks/ βββ Navigation/ βββ UIElements/ βββ Util/
The common folder contains components that are used by other components like loading animations, custom buttons, custom hooks, etc.
App
The app folder contains the main app with all the features like the dashboard, profile page, etc. So you can think app folder as the actual app that unlocks after login.
Component Structure
Now let's take a look at how I structure a component.
Naming
Component name, the file name that contains the component, style sheet file name of the respective component will be the same.
Here's how I structure a component-
For example,
1import react, { useState, useEffect } from 'React'; 2import axios from 'axios'; 3 4import 'CompName.scss'; 5 6const CompName = (props) => { 7 const [visits, setVisits] = useState(0); 8 const [color, setColor] = useState('red'); 9 10 const name = "Cat"; 11 12 useEffect(() => { 13 setVisits(1); 14 }); 15 16 const someFunction = () => { 17 // do something 18 }; 19 20 return ( 21 <div> 22 <h1>Visits: {visits}</h1> 23 </div> 24 ); 25}; 26 27export default CompName;
That's it!
βοΈ Tool of the week βοΈ
While designing a website we get confused about what to include on different pages. For example, what all things need to be included on the pricing page? Here comes this website to rescue.
Thanks for reading!
LEAVE A COMMENT OR START A DISCUSSION
MORE ARTICLES
5 min read
Hiring Angular Developers in 2023: Insider Tips & Strategies
Does your company struggle to create a modern, high-performance, cross-platform web app? Do you desire cost-effective development without compromising future software quality? Many web development teams utilize Angular to build complicated single-page apps. Hiring Angular programmers is difficult.
8 min read
How Feature Flags Can Help You Ship Faster and Smarter?
Are you tired of long development cycles and hesitant to push new features to production? Feature flags may be the solution you're looking for. In this blog post, we'll explore how feature flags can streamline your development process, reduce the risk of errors, and give you more control over the features you release to your users. From testing new features to rolling out changes to a select group of users, feature flags can help you do it all. Keep reading to learn how you can start using feature flags in your development workflow today.