DEV Community

Abhay Singh Kathayat
Abhay Singh Kathayat

Posted on

Optimizing Performance with Lazy Loading in React Router v6

Lazy Loading with React Router v6

Lazy loading is a technique in web development that allows you to load components only when they are needed, rather than loading everything upfront. This is especially useful in large applications where loading all components at once could slow down the initial page load.

React Router v6 works seamlessly with React's built-in React.lazy and Suspense for implementing lazy loading of routes. By using these features, you can improve your app’s performance and user experience by loading components only when the user navigates to them.


How Lazy Loading Works in React Router v6

In React, React.lazy is used to dynamically import a component, and Suspense is used to wrap the lazy-loaded component while it is being fetched. React Router v6 makes it easy to integrate these concepts to lazily load routes.

Steps to Implement Lazy Loading in React Router v6:

  1. Use React.lazy to Lazy Load Components

    • React.lazy allows you to define components that are loaded only when the route is accessed.
  2. Use Suspense to Wrap Lazy Loaded Components

    • Suspense is used to specify a fallback UI (like a loading spinner) while the component is being loaded.

Example: Lazy Loading with React Router v6

Step 1: Install Required Dependencies

Ensure you have React Router v6 installed:

npm install react-router-dom@6
Enter fullscreen mode Exit fullscreen mode

Step 2: Define Your Lazy Loaded Components

import React, { Suspense } from 'react';
import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';

// Lazy load components using React.lazy
const Home = React.lazy(() => import('./Home'));
const About = React.lazy(() => import('./About'));
const Contact = React.lazy(() => import('./Contact'));

// Fallback UI component to show while lazy-loaded component is loading
const FallbackLoader = () => <div>Loading...</div>;

const App = () => {
  return (
    <Router>
      <Suspense fallback={<FallbackLoader />}>
        <Routes>
          <Route path="/" element={<Home />} />
          <Route path="/about" element={<About />} />
          <Route path="/contact" element={<Contact />} />
        </Routes>
      </Suspense>
    </Router>
  );
};

export default App;
Enter fullscreen mode Exit fullscreen mode

Explanation:

  1. React.lazy(() => import('./Home')):

    • React.lazy dynamically imports the component only when it's needed, reducing the initial bundle size of your application.
    • This is done for Home, About, and Contact components in the example.
  2. Suspense:

    • The Suspense component is wrapped around the entire <Routes> block to provide a fallback UI (<FallbackLoader />) when the lazy-loaded components are being fetched.
    • This ensures that a loading spinner or message appears while the component is being loaded.
  3. fallback Prop in Suspense:

    • The fallback prop specifies the UI that should be displayed while the lazy-loaded component is being fetched (in this case, it is a simple loading message).

Lazy Loading with Nested Routes

Lazy loading can also be applied to nested routes, improving the load time for pages with nested components.

import React, { Suspense } from 'react';
import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';

const Dashboard = React.lazy(() => import('./Dashboard'));
const DashboardOverview = React.lazy(() => import('./DashboardOverview'));
const DashboardSettings = React.lazy(() => import('./DashboardSettings'));

const FallbackLoader = () => <div>Loading...</div>;

const App = () => {
  return (
    <Router>
      <Suspense fallback={<FallbackLoader />}>
        <Routes>
          <Route path="/" element={<Home />} />
          <Route path="/dashboard" element={<Dashboard />}>
            <Route path="overview" element={<DashboardOverview />} />
            <Route path="settings" element={<DashboardSettings />} />
          </Route>
        </Routes>
      </Suspense>
    </Router>
  );
};

export default App;
Enter fullscreen mode Exit fullscreen mode

Explanation:

  • Here, the Dashboard, DashboardOverview, and DashboardSettings components are lazy-loaded when their corresponding routes are accessed.
  • The Suspense component wraps the routes to show a fallback loading state while these nested components are loading.

Best Practices for Lazy Loading in React Router v6

  1. Chunking and Code Splitting: React Router allows you to split your app into chunks, with each route being a separate bundle that can be loaded on demand. This reduces the initial load time and speeds up the app.

  2. Use Fallbacks Wisely: Make sure the fallback UI provides a good user experience. A simple loading spinner or text is usually enough, but you can customize it further.

  3. Preload Critical Routes: For critical pages that users will likely navigate to first, consider preloading these routes in the background so that they are ready when the user navigates to them.

  4. Limit Lazy Loading: Use lazy loading for non-critical components. Do not overuse lazy loading for small components that won’t significantly affect the initial load time.


Conclusion

Lazy loading in React Router v6, powered by React.lazy and Suspense, helps optimize the performance of your React applications by loading components only when they are needed. It improves the user experience by reducing the initial load time and allows you to efficiently manage large applications.

By combining React.lazy for code-splitting and Suspense for fallback UIs, React Router v6 makes it easy to implement lazy loading for both top-level and nested routes.


Top comments (0)