Skip to content

React Routing

Understanding react routing helps you work with Module Federation confidently. Here you will learn the core ideas behind react routing, see working code, and pick up best practices used on real teams.

React Routing Overview

React Routing lets you structure Module Federation work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep react routing focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

import React, { Suspense } from 'react';
const ProductList = React.lazy(() => import('catalog/ProductList'));

export default function App() {
  return (
    <Suspense fallback={<p>Loading...</p>}>
      <ProductList />
    </Suspense>
  );
}

In React, a federated remote is loaded with React.lazy and rendered inside a Suspense boundary.

React Routing Example

new ModuleFederationPlugin({
  name: 'app',
  filename: 'remoteEntry.js',
  exposes: { './Widget': './src/Widget' },
  remotes: { other: 'other@http://host/remoteEntry.js' },
  shared: { react: { singleton: true } },
});
  • Start from a minimal React Routing example and grow it only as needed.
  • Keep configuration explicit so React Routing behaves the same in every environment.
  • Name things clearly so teammates understand your React Routing at a glance.
  • Add tests around React Routing early to lock in expected behaviour.

Module Federation Cheatsheet

Key Module Federation settings related to react routing.

Option Example Purpose
name name: 'shell' Unique container name
filename filename: 'remoteEntry.js' Remote entry manifest
exposes exposes: { './X': './src/X' } Modules a remote shares
remotes remotes: { app: 'app@url' } Remotes a host consumes
shared shared: { react: { singleton: true } } Deduplicate libraries
lazy load import('remote/Module') Load remotes on demand
Suspense <Suspense fallback={...}> Handle async loading

How React Routing Works in Module Federation

React Routing builds on Module Federation's ability to load code from another independently built and deployed application at runtime. Each app can be a host, a remote, or both.

In React, a federated remote is loaded with React.lazy and rendered inside a Suspense boundary.

  • Remotes expose modules through a remoteEntry.js manifest.
  • Hosts declare remotes and import exposed modules dynamically.
  • Shared dependencies are deduplicated, ideally as singletons.
  • Each micro frontend builds and deploys on its own schedule.

Practical Guidance for React Routing

In production, react routing needs careful version management and graceful failure handling. Align shared dependency versions and always render a fallback when a remote cannot load.

Concern Recommendation
Shared versions Use singletons with requiredVersion
Runtime errors Wrap remotes in error boundaries and fallbacks
Deployment Resolve remotes from a runtime manifest
Performance Lazy-load remotes and cache remoteEntry.js

Common Mistakes

  • Skipping error handling and edge cases when wiring up react routing.
  • Leaving react routing untested, so regressions slip into production.
  • Over-engineering react routing before you actually need the extra flexibility.
  • Ignoring documentation, which makes react routing hard for the next developer to change.

Key Takeaways

  • React Routing is a core part of working effectively with Module Federation.
  • Start small and keep react routing focused on a single responsibility.
  • Apply consistent patterns so react routing scales across your project.
  • Test and document react routing to keep it maintainable over time.

Pro Tip

When you get stuck on react routing, reduce it to the smallest reproducible example first — most Module Federation issues become obvious once the noise is gone.