> ## Documentation Index
> Fetch the complete documentation index at: https://peacockindia.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Best Practices for Code Splitting in Web Development
> Learn the importance of modular code organization, with examples of good and bad practices in React.js projects.
Effective code organization is key to maintaining a scalable, readable, and maintainable codebase. This document discusses good and bad practices in code splitting, particularly in the context of React.js development, and provides examples for a more modular code structure.
## The Problem with Monolithic Code Structures ⚠️
Monolithic or single-file code structures can lead to several issues:
* **Difficult Maintenance**: Large files with mixed concerns are harder to understand and maintain.
* **Poor Readability**: Finding specific code segments becomes challenging as the file size grows. An example from personal experience is encountering files extending to 15,000 lines of code, which can be overwhelming and difficult to manage.
* **Name Clashing**: In extensive single files, reusing names for functions or components across different contexts can lead to conflicts and confusion, making debugging difficult.
### Bad Practice Example 📛
Avoid placing all components, utilities, and types in one large file. For instance, defining multiple modals, utilities, and type declarations in a single file leads to clutter and confusion.
```js Example Large files theme={null}
// Bad Practice: Everything in one file
import React from 'react';
// Imports for components, utilities, types all mixed together...
const MyComponent = () => { /* ... */ };
const AnotherComponent = () => { /* ... */ };
// Multiple components and utility functions defined here...
// thousands of lines of code... 🚂
export default MyComponent;
```
```js Name Clashing Example 1 theme={null}
// Function to calculate the area of a circle
function calculateArea(radius) {
return Math.PI * radius * radius;
}
// Later in the same file, another calculateArea function is defined for a square
function calculateArea(side) {
return side * side;
}
// Usage
const circleArea = calculateArea(5); // Intended to calculate area of a circle
```
```js Name Clashing Example 2 theme={null}
import React, { useState } from 'react';
const LargeComponent = () => {
// First useState for user input
const [input, setInput] = useState('');
const handleInputChange = (e) => {
setInput(e.target.value);
};
// ... many other states and handlers ...
// Accidental redeclaration of the same state and handler
const [input, setInput] = useState('');
const handleInputChange = () => {
// Logic intended for a different purpose
};
// ... more code ...
return (
{/* Other components and logic */}
);
};
```
## Good Practices in Code Splitting 🚀
### Modular Component Structure
Organize components into separate files and directories. This improves readability and maintenance.
```js theme={null}
// Good Practice: Modular structure with sub-components
import React from 'react';
import SuccessModal from './SuccessModal';
// ...other imports
const Modal = ({ variant, ...props }) => {
// Component logic
return
{/* Render selected modal based on variant */}
;
};
export default Modal;
```
Example: Modal Component Structure
```mdx theme={null}
.
└── Modal/
├── index.jsx
├── SuccessModal.jsx
├── WarningModal.jsx
├── DangerModal.jsx
├── LoginModal.jsx
```
### Modal Component Code example 🤓
```js index.jsx theme={null}
import React from 'react';
// ** import sub components
import SuccessModal from './SuccessModal';
import WarningModal from './WarningModal';
import DangerModal from './DangerModal';
import LoginModal from './LoginModal';
/**
* @typedef {'success' | 'warning' | 'danger' | 'login'} ModalVariant
* @typedef {'opaque' | 'blur' | 'transparent'} BackdropVariant
* @typedef {'auto' | 'top' | 'center' | 'bottom' | 'bottom-center' | 'top-center'} placement
*/
/**
* Modal component.
*
* @param {Object} props - The component props.
* @param {ModalVariant} props.variant - The variant of the header to render.
* @param {string} props.title
* @param {string} props.description
* @param {string} props.yesText
* @param {string}props.noText
* @param {Function} props.btnFunction - The function to call when button is clicked.
* @param {Function} props.yesFunction - The function to call when 'yes' is clicked.
* @param {Function} props.noFunction - The function to call when 'no' is clicked.
* @param {BackdropVariant} props.backdropVariant - The variant of the backdrop to render.
* @param {boolean} props.hideCloseButton - A boolean indicating whether a close button is present.
* @param {boolean} props.outsideClickClose - The boolean indicating whether the modal should close when clicking outside the modal
* @param {placement} props.placement - The placement of the modal
* @returns {JSX.Element|null} The rendered header component.
*
*/
const Modal = ({ variant, ...props }) => {
const variantComponents = {
success: SuccessModal,
warning: WarningModal,
danger: DangerModal,
login: LoginModal
};
const SelectedModal = variantComponents[variant] || null;
return
{SelectedModal && }
;
};
export default Modal;
```
```js SuccessModal.jsx theme={null}
import React from 'react';
// ** import next ui
import { Modal, ModalContent } from '@nextui-org/react';
// ** import shared components
import Typography from '@shared/Typography';
import Button from '@shared/Button';
// ** import assets
import SuccessSvg from '@icons/SuccessSvg';
// ** import redux
import { useSelector, useDispatch } from 'react-redux';
import { setAlertModel } from '@redux/slices/utils';
/**
* @typedef {'opaque' | 'blur' | 'transparent'} BackdropVariant
* @typedef {'auto' | 'top' | 'center' | 'bottom' | 'bottom-center' | 'top-center'} placement
*/
/**
* SuccessModal component.
*
* @param {Object} props - The component props.
* @param {string} props.title - The title for the modal.
* @param {string} props.description - The description for the modal.
* @param {string} props.btnText - The text for the button.
* @param {Function} props.btnFunction - The function to call when the button is clicked.
* @param {BackdropVariant} props.backdropVariant - The variant of the backdrop to render.
* @param {boolean} props.hideCloseButton - A boolean indicating whether a close button is present.
* @param {placement} props.placement - The placement of the modal
* @param {boolean} props.outsideClickClose - A boolean indicating whether the outside click closes the modal
* @returns {JSX.Element} The rendered SuccessModal component.
*/
const SuccessModal = ({
title,
description,
btnText,
btnFunction,
backdropVariant = 'blur', // default backdrop is blur
hideCloseButton = true, // default hide close button
placement = 'center', // default placement is center
outsideClickClose = true, // default outside click true
}) => {
const dispatch = useDispatch();
const { alertModel } = useSelector((state) => state.utils);
/**
* Handles the close action.
*/
const handleClose = () => {
dispatch(setAlertModel(false));
if (btnFunction) {
btnFunction();
}
};
/**
* Handles the outside click action.
*/
const handleOutsideClick = () => {
if (outsideClickClose) {
dispatch(setAlertModel(false));
}
};
return (
{title}
{description}
);
};
export default SuccessModal;
```
```js WarningModal.jsx theme={null}
import React from 'react';
// ** import next ui
import { Modal, ModalContent } from '@nextui-org/react';
// ** import shared components
import Typography from '@shared/Typography';
import Button from '@shared/Button';
// ** import assets
import WarningSvg from '@icons/WarningSvg';
// ** import redux
import { useSelector, useDispatch } from 'react-redux';
import { setAlertModel } from '@redux/slices/utils';
/**
* @typedef {'opaque' | 'blur' | 'transparent'} BackdropVariant
* @typedef {'auto' | 'top' | 'center' | 'bottom' | 'bottom-center' | 'top-center'} placement
*/
/**
* WarningModal component.
*
* @param {Object} props - The component props.
* @param {string} props.title - The title for the warning modal.
* @param {string} props.description - The description for the warning modal.
* @param {string} props.yesText - The text for the 'Yes' button.
* @param {string} props.noText - The text for the 'No' button.
* @param {Function} props.yesFunction - The function to call when 'Yes' is clicked.
* @param {Function} props.noFunction - The function to call when 'No' is clicked.
* @param {BackdropVariant} props.backdropVariant - The variant of the backdrop to render.
* @param {boolean} props.hideCloseButton - A boolean indicating whether a close button is present.
* @param {placement} props.placement - The placement of the modal
* @param {boolean} props.outsideClickClose - A boolean indicating whether the outside click closes the modal
* @returns {JSX.Element} The rendered WarningModal component.
*/
const WarningModal = ({
title,
description,
yesText,
noText,
yesFunction,
noFunction,
backdropVariant = 'blur', // default backdrop is blur
hideCloseButton = true, // default hide close button
placement = 'center', // default placement is center
outsideClickClose = true, // default outside click true
}) => {
const dispatch = useDispatch();
const { alertModel } = useSelector((state) => state.utils);
/**
* Function to handle the 'No' button click.
*/
const cancelFunction = () => {
dispatch(setAlertModel(false));
if (noFunction) {
noFunction();
}
};
/**
* Function to handle the 'Yes' button click.
*/
const confirmFunction = () => {
dispatch(setAlertModel(false));
if (yesFunction) {
yesFunction();
}
};
/**
* Handles the outside click action.
*/
const handleOutsideClick = () => {
if (outsideClickClose) {
cancelFunction();
}
};
return (
dispatch(setAlertModel(false))}
>
{title}
{description}
);
};
export default WarningModal;
```
```js DangerModal.jsx theme={null}
import React from 'react';
// ** import next ui
import { Modal, ModalContent } from '@nextui-org/react';
// ** import shared components
import Typography from '@shared/Typography';
import Button from '@shared/Button';
// ** import assets
import Danger from '@icons/Danger';
// ** import redux
import { useSelector, useDispatch } from 'react-redux';
import { setAlertModel } from '@redux/slices/utils';
/**
* @typedef {'opaque' | 'blur' | 'transparent'} BackdropVariant
* @typedef {'auto' | 'top' | 'center' | 'bottom' | 'bottom-center' | 'top-center'} placement
*/
/**
* DangerModal component.
*
* @param {Object} props - The component props.
* @param {string} props.title - The title of the modal.
* @param {string} props.description - The description of the modal.
* @param {string} props.yesText - The text for the 'Yes' button.
* @param {string} props.noText - The text for the 'No' button.
* @param {Function} props.yesFunction - The function to call when 'Yes' is clicked.
* @param {Function} props.noFunction - The function to call when 'No' is clicked.
* @param {BackdropVariant} props.backdropVariant - The variant of the backdrop to render.
* @param {boolean} props.hideCloseButton - A boolean indicating whether a close button is present.
* @param {placement} props.placement - The placement of the modal
* @param {boolean} props.outsideClickClose - A boolean indicating whether the outside click closes the modal
* @returns {JSX.Element} The rendered DangerModal component.
*/
const DangerModal = ({
title,
description,
yesText,
noText,
yesFunction,
noFunction,
backdropVariant = 'blur', // default backdrop is blur
hideCloseButton = true, // default hide close button
placement = 'center', // default placement is center
outsideClickClose = true, // default outside click true
}) => {
const dispatch = useDispatch();
const { alertModel } = useSelector((state) => state.utils);
/**
* Function to handle the 'No' button click.
*/
const cancelFunction = () => {
if (noFunction) {
noFunction();
}
dispatch(setAlertModel(false));
};
/**
* Function to handle the 'Yes' button click.
*/
const confirmFunction = () => {
dispatch(setAlertModel(false));
if (yesFunction) {
yesFunction();
}
};
/**
* Handles the outside click action.
*/
const handleOutsideClick = () => {
if (outsideClickClose) {
cancelFunction();
}
};
return (
{title}
{description}
);
};
export default DangerModal;
```
```js LoginModal.jsx theme={null}
import React from 'react';
// ** import next ui
import { Modal, ModalContent } from '@nextui-org/react';
// ** import shared components
import Typography from '@shared/Typography';
import Button from '@shared/Button';
import Image from '@shared/Image';
// ** import assets
import WarningSvg from '@icons/WarningSvg';
import googleSvg from '@svg/google.svg';
// ** import redux
import { useSelector, useDispatch } from 'react-redux';
import { setLoginModel } from '@redux/slices/utils';
// ** import config
import env from '@src/config';
/**
* @typedef {'opaque' | 'blur' | 'transparent'} BackdropVariant
* @typedef {'auto' | 'top' | 'center' | 'bottom' | 'bottom-center' | 'top-center'} placement
*/
/**
* LoginModal component.
*
* @param {Object} props - The component props.
* @param {string} props.title - The title for the modal.
* @param {string} props.description - The description for the modal.
* @param {string} props.btnText - The text for the button.
* @param {Function} props.btnFunction - The function to call when the button is clicked.
* @param {BackdropVariant} props.backdropVariant - The variant of the backdrop to render.
* @param {boolean} props.hideCloseButton - A boolean indicating whether a close button is present.
* @param {placement} props.placement - The placement of the modal
* @param {boolean} props.outsideClickClose - A boolean indicating whether the outside click closes the modal
* @returns {JSX.Element} The rendered LoginModal component.
*/
const LoginModal = ({
title,
description,
btnText,
btnFunction,
backdropVariant = 'blur', // default backdrop is blur
hideCloseButton = true, // default hide close button
placement = 'center', // default placement is center
outsideClickClose = true, // default outside click true
}) => {
const dispatch = useDispatch();
const { loginModel } = useSelector((state) => state.utils);
/**
* Handles the close action.
*/
const handleClose = () => {
dispatch(setLoginModel(false));
if (btnFunction) {
btnFunction();
}
};
/**
* redirects to google login
*/
const redirectToExternalLink = () => {
try {
dispatch(setLoginModel(false));
window.location.href = `${env.BASE_URL}/api/v1/auth/google`;
} catch (error) {
console.log("Error at google login", error);
}
};
/**
* Handles the outside click action.
*/
const handleOutsideClick = () => {
if (outsideClickClose) {
handleClose();
}
};
return (
{title ?? 'Login required'}
{description ?? 'Please login to enjoy special features'}
);
};
export default LoginModal;
```
### Separate Utilities and Helpers
Place utility functions and helpers in separate files or directories.
Example: Utility Function
```js theme={null}
// utils/formatDate.js
export const formatDate = (date) => {
// Format date logic
};
```
### Define Types and Interfaces Separately
For TypeScript or PropTypes in React, define types or interfaces in dedicated files.
Example: Type Definitions
```js theme={null}
// types/modalTypes.ts
export type ModalVariant = 'success' | 'warning' | 'danger' | 'login';
```
### Form Validation in Separate Files
Keep form validations separate, especially when using libraries like Formik or React Hook Form.
Example: Form Validation Logic
```js theme={null}
// validation/loginValidation.js
import * as Yup from 'yup';
export const loginValidationSchema = Yup.object().shape({
// Validation schema
});
```
## Additional Examples
* **Component Styles**: Define styles in separate CSS or SCSS files, or use CSS-in-JS styled components.
* **API Calls**: Separate API call functions into a dedicated service or API layer.
* **Contexts and Hooks**: Define React contexts and custom hooks in their own files.
Conclusion
Adopting a modular code structure by splitting your code into logical and coherent units not only enhances readability and maintainability but also prevents conflicts and encourages code reuse. This approach is essential in collaborative environments and large-scale applications.
Effective code organization is key to maintaining a scalable, readable, and maintainable codebase. This document discusses good and bad practices in code splitting, particularly in the context of React.js development, and provides examples for a more modular code structure.
## The Problem with Monolithic Code Structures ⚠️
Monolithic or single-file code structures can lead to several issues:
* **Difficult Maintenance**: Large files with mixed concerns are harder to understand and maintain.
* **Poor Readability**: Finding specific code segments becomes challenging as the file size grows. An example from personal experience is encountering files extending to