A build-time plugin for Vue Router that provides automatic file-based routing with full TypeScript support.
unplugin-vue-router is a build-time plugin that automatically generates Vue Router routes from your project's file structure. It solves the problem of manual route configuration by providing file-based routing with full TypeScript support, making routing safer and easier to use.
Vue 3 developers using Vue Router who want to simplify their routing setup with automatic file-based routing and enhanced type safety.
Developers choose unplugin-vue-router because it eliminates manual route configuration while providing excellent TypeScript integration, reducing errors and improving developer experience through intuitive file-based routing patterns.
Next Generation file based typed routing for Vue Router
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Eliminates manual configuration by generating Vue Router routes directly from your project's file structure, reducing setup time and potential errors, as highlighted in the file-based routing feature.
Provides end-to-end type safety for route parameters, navigation, and matching, making code safer and easier to refactor, emphasized in the README's focus on TypeScript support.
Works as a plugin for Vite, Rollup, Webpack, and other bundlers, offering easy integration into diverse development environments, demonstrated in the installation examples.
Designed for Vue Router >=4.4.0 and integrates smoothly with existing setups, ensuring compatibility with modern Vue ecosystems without major overhauls.
Requires running the dev server to generate types and manual configuration of TypeScript files, which can be error-prone and time-consuming for newcomers, as detailed in the Setup section.
Includes APIs like Data Loaders that are marked as experimental and subject to change, posing risks for production applications that need stable, reliable routing.
Enforces a convention-over-configuration model that may not fit projects with unconventional or highly dynamic routing patterns, limiting flexibility outside standard file hierarchies.