Skip to content

React Lifecycle Integration

React Lifecycle Integration sits at the heart of react integration in single-spa. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

React Lifecycle Integration Overview

React Lifecycle Integration is a building block you will reach for often in single-spa. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn react lifecycle integration properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real single-spa projects.

export async function bootstrap(props) {
  // one-time setup
}

export async function mount(props) {
  // render the app into props.domElement
}

export async function unmount(props) {
  // tear down and clean up
}

Every single-spa application exports bootstrap, mount, and unmount lifecycle functions.

React Lifecycle Integration Example

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});
start();
  • Start from a minimal React Lifecycle Integration example and grow it only as needed.
  • Keep configuration explicit so React Lifecycle Integration behaves the same in every environment.
  • Name things clearly so teammates understand your React Lifecycle Integration at a glance.
  • Add tests around React Lifecycle Integration early to lock in expected behaviour.

Single-SPA Cheatsheet

Core single-spa APIs related to react lifecycle integration.

API Example Purpose
registerApplication registerApplication({ name, app, activeWhen }) Register a micro frontend
activeWhen activeWhen: ['/checkout'] Route ownership
start start() Begin routing
bootstrap export async function bootstrap() One-time setup
mount export async function mount(props) Render the app
unmount export async function unmount(props) Clean up the app
import map systemjs-importmap Locate app bundles

How React Lifecycle Integration Works in Single-SPA

React Lifecycle Integration is part of how single-spa lets multiple applications — even in different frameworks — coexist on one page. A root config registers each app and controls when it is active.

Every single-spa application exports bootstrap, mount, and unmount lifecycle functions.

  • A root config registers apps and calls start().
  • Each app exports bootstrap, mount, and unmount lifecycles.
  • activeWhen decides which routes each app owns.
  • Import maps resolve each app's bundle at runtime.

Practical Guidance for React Lifecycle Integration

For reliable micro frontends, react lifecycle integration should isolate failures and keep shared state minimal. Let each team own its app end to end while agreeing on a few shared contracts.

Concern Recommendation
Isolation One app's crash should not break others
Shared state Prefer shared utility modules over globals
Routing Keep activeWhen rules explicit and non-overlapping
Deployment Release via import-map updates per app

Common Mistakes

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

Key Takeaways

  • React Lifecycle Integration is a core part of working effectively with single-spa.
  • Start small and keep react lifecycle integration focused on a single responsibility.
  • Apply consistent patterns so react lifecycle integration scales across your project.
  • Test and document react lifecycle integration to keep it maintainable over time.

Pro Tip

Pair react lifecycle integration with automated tests from day one. It is far cheaper to catch single-spa regressions in CI than in production.