Skip to content

Vue State Management

Vue State Management sits at the heart of vue integration in single-spa. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

Vue State Management Overview

Vue State Management 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 vue state management 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 { 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 State Management Example

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

Single-SPA Cheatsheet

Core single-spa APIs related to vue state management.

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 State Management Works in Single-SPA

Vue State Management 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 State Management

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

Key Takeaways

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

Pro Tip

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