Skip to content

Angular Routing

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

Angular Routing Overview

Angular Routing 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 angular routing 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.

import { singleSpaAngular } from 'single-spa-angular';
import { enableProdMode } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { AppModule } from './app/app.module';

export const { bootstrap, mount, unmount } = singleSpaAngular({
  bootstrapFunction: () => platformBrowserDynamic().bootstrapModule(AppModule),
  template: '<app-root />',
});

single-spa-angular wraps an Angular module as a single-spa micro frontend.

Angular Routing Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to angular routing.

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 Angular Routing Works in Single-SPA

Angular Routing 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-angular wraps an Angular module as a single-spa micro frontend.

  • 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 Angular Routing

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

Key Takeaways

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

Pro Tip

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