Skip to content

Design Systems with Single-SPA

Design Systems with Single-SPA is an important part of building production-ready single-spa systems. This lesson explains what design systems with single-spa means, how it works, and how to apply it with practical examples you can reuse.

Design Systems with Single-SPA Overview

At its core, design systems with single-spa is about doing one thing well inside your single-spa project. Once you understand the pattern, you can apply it consistently across features and teams.

Good design systems with single-spa pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

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.

Design Systems with Single-SPA Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to design systems with single-spa.

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 Design Systems with Single-SPA Works in Single-SPA

Design Systems with Single-SPA 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 Design Systems with Single-SPA

For reliable micro frontends, design systems with single-spa 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

  • Copying design systems with single-spa snippets without understanding what each line does.
  • Skipping error handling and edge cases when wiring up design systems with single-spa.
  • Leaving design systems with single-spa untested, so regressions slip into production.
  • Over-engineering design systems with single-spa before you actually need the extra flexibility.

Key Takeaways

  • Design Systems with Single-SPA is a core part of working effectively with single-spa.
  • Start small and keep design systems with single-spa focused on a single responsibility.
  • Apply consistent patterns so design systems with single-spa scales across your project.
  • Test and document design systems with single-spa to keep it maintainable over time.

Pro Tip

Bookmark this design systems with single-spa pattern and reuse it. Consistency across your single-spa codebase is worth more than clever one-off solutions.