Skip to content

Lazy Loading Applications

Understanding lazy loading applications helps you work with single-spa confidently. Here you will learn the core ideas behind lazy loading applications, see working code, and pick up best practices used on real teams.

Lazy Loading Applications Overview

Lazy Loading Applications lets you structure single-spa 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 lazy loading applications focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

import { registerApplication, start } from 'single-spa';

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});

start();

single-spa orchestrates multiple framework apps on one page through a root config.

Lazy Loading Applications Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to lazy loading applications.

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 Lazy Loading Applications Works in Single-SPA

Lazy Loading Applications 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.

single-spa orchestrates multiple framework apps on one page through a root config.

  • 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 Lazy Loading Applications

For reliable micro frontends, lazy loading applications 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 lazy loading applications.
  • Leaving lazy loading applications untested, so regressions slip into production.
  • Over-engineering lazy loading applications before you actually need the extra flexibility.
  • Ignoring documentation, which makes lazy loading applications hard for the next developer to change.

Key Takeaways

  • Lazy Loading Applications is a core part of working effectively with single-spa.
  • Start small and keep lazy loading applications focused on a single responsibility.
  • Apply consistent patterns so lazy loading applications scales across your project.
  • Test and document lazy loading applications to keep it maintainable over time.

Pro Tip

When you get stuck on lazy loading applications, reduce it to the smallest reproducible example first — most single-spa issues become obvious once the noise is gone.