Skip to content

Vue Router Integration

Vue Router Integration sits at the heart of vue integration in Module Federation. This guide walks through the concept step by step, with examples, a cheatsheet, and common mistakes to avoid.

Vue Router Integration Overview

At its core, vue router integration is about doing one thing well inside your Module Federation 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 { defineAsyncComponent } from 'vue';

const ProductList = defineAsyncComponent(() => import('catalog/ProductList'));

export default { components: { ProductList } };

Vue loads a federated remote with defineAsyncComponent, mirroring React.lazy.

Vue Router Integration Example

new ModuleFederationPlugin({
  name: 'app',
  filename: 'remoteEntry.js',
  exposes: { './Widget': './src/Widget' },
  remotes: { other: 'other@http://host/remoteEntry.js' },
  shared: { react: { singleton: true } },
});
  • 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.

Module Federation Cheatsheet

Key Module Federation settings related to vue router integration.

Option Example Purpose
name name: 'shell' Unique container name
filename filename: 'remoteEntry.js' Remote entry manifest
exposes exposes: { './X': './src/X' } Modules a remote shares
remotes remotes: { app: 'app@url' } Remotes a host consumes
shared shared: { react: { singleton: true } } Deduplicate libraries
lazy load import('remote/Module') Load remotes on demand
Suspense <Suspense fallback={...}> Handle async loading

How Vue Router Integration Works in Module Federation

Vue Router Integration builds on Module Federation's ability to load code from another independently built and deployed application at runtime. Each app can be a host, a remote, or both.

Vue loads a federated remote with defineAsyncComponent, mirroring React.lazy.

  • Remotes expose modules through a remoteEntry.js manifest.
  • Hosts declare remotes and import exposed modules dynamically.
  • Shared dependencies are deduplicated, ideally as singletons.
  • Each micro frontend builds and deploys on its own schedule.

Practical Guidance for Vue Router Integration

In production, vue router integration needs careful version management and graceful failure handling. Align shared dependency versions and always render a fallback when a remote cannot load.

Concern Recommendation
Shared versions Use singletons with requiredVersion
Runtime errors Wrap remotes in error boundaries and fallbacks
Deployment Resolve remotes from a runtime manifest
Performance Lazy-load remotes and cache remoteEntry.js

Common Mistakes

  • 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.
  • Ignoring documentation, which makes vue router integration hard for the next developer to change.

Key Takeaways

  • Vue Router Integration is a core part of working effectively with Module Federation.
  • 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 Module Federation codebase is worth more than clever one-off solutions.