Skip to content

React and Vue Integration

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

React and Vue Integration Overview

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

import React from 'react';
import ReactDOMClient from 'react-dom/client';
import singleSpaReact from 'single-spa-react';
import Root from './root.component';

const lifecycles = singleSpaReact({
  React,
  ReactDOMClient,
  rootComponent: Root,
});

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

single-spa-react adapts a React app into single-spa lifecycle functions.

React and Vue Integration Example

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

Single-SPA Cheatsheet

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

React and Vue 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-react adapts a React app into single-spa lifecycle functions.

  • 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 React and Vue Integration

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

  • Skipping error handling and edge cases when wiring up react and vue integration.
  • Leaving react and vue integration untested, so regressions slip into production.
  • Over-engineering react and vue integration before you actually need the extra flexibility.
  • Ignoring documentation, which makes react and vue integration hard for the next developer to change.

Key Takeaways

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

Pro Tip

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