vue3-routable-vite-plugin

vue3-routable-vite-plugin is the Vite integration for vue3-routable.

It scans configured source files for @Routable(...) classes and ROUTABLE_TARGETS exports, then generates the lazy-route manifest consumed by vue3-routable at runtime.

Published on npm as vue3-routable-vite-plugin starting with v1.1.0.

The legacy vue3-routable-lazy-loader package is intended to remain on npm as the pre-v1.1.0 line and should be deprecated in favor of this package.

See CHANGELOG.md for release notes.

Usage

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { vue3RoutableVitePlugin } from 'vue3-routable-vite-plugin'

export default defineConfig({
    plugins: [vue(), vue3RoutableVitePlugin()],
})

The legacy vue3RoutableLazyLoader and vue3RoutablePlugin exports still work as compatibility aliases.

Overview

Use this plugin when your vue3-routable app wants lazy-loaded controller modules.

It is responsible for:

• scanning source files for @Routable(...) and ROUTABLE_TARGETS
• generating virtual:vue3-routable-manifest
• optionally emitting ambient declarations for that virtual module when dts is enabled

Documentation

The canonical documentation lives in the vue3-routable VitePress site so the lazy-loading and SSR guidance stays in one place.

• Lazy Loading Guide
• Official Docs Home

For configuration details, SSR notes, and end-to-end examples, prefer the official docs over duplicating that material here.