Skip to content

SystemJS with Webpack

SystemJS with Webpack sits at the heart of systemjs in single-spa. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

SystemJS with Webpack Overview

At its core, systemjs with webpack 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 systemjs with webpack pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

<script type="systemjs-importmap">
{
  "imports": {
    "@org/root-config": "//localhost:9000/org-root-config.js",
    "@org/navbar": "//localhost:8500/org-navbar.js"
  }
}
</script>

Import maps tell SystemJS where to load each micro frontend bundle at runtime.

SystemJS with Webpack Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to systemjs with webpack.

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 SystemJS with Webpack Works in Single-SPA

SystemJS with Webpack 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.

Import maps tell SystemJS where to load each micro frontend bundle at runtime.

  • 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 SystemJS with Webpack

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

Key Takeaways

  • SystemJS with Webpack is a core part of working effectively with single-spa.
  • Start small and keep systemjs with webpack focused on a single responsibility.
  • Apply consistent patterns so systemjs with webpack scales across your project.
  • Test and document systemjs with webpack to keep it maintainable over time.

Pro Tip

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