Skip to content

Vue Router Integration

In this lesson you will learn vue router integration in single-spa, why it matters within vue integration, and how to use it correctly with clear, copy-ready examples.

Vue Router Integration Overview

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

import { h, createApp } from 'vue';
import singleSpaVue from 'single-spa-vue';
import App from './App.vue';

const vueLifecycles = singleSpaVue({
  createApp,
  appOptions: { render: () => h(App) },
});

export const { bootstrap, mount, unmount } = vueLifecycles;

single-spa-vue turns a Vue app into mountable single-spa lifecycles.

Vue Router Integration Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to vue router 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 Vue Router Integration Works in Single-SPA

Vue Router 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.

single-spa-vue turns a Vue app into mountable single-spa lifecycles.

  • 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 Vue Router Integration

For reliable micro frontends, vue router 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

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

Key Takeaways

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

Pro Tip

Bookmark this vue router integration pattern and reuse it. Consistency across your single-spa codebase is worth more than clever one-off solutions.