About this project
Vue Router 3 is the official router for Vue 2, maintained as part of the Vue ecosystem under the MIT license. It handles client-side routing for single-page applications built with Vue 2, mapping URL paths to components and managing navigation without full page reloads.
The README states clearly that this is vue-router 3.0, which works only with Vue 2.0, and that both have reached end of life. Users on Vue 3 are pointed to the separate vuejs/router repository for Vue Router 4, while the 1.x line lives on the 1.0 branch.
Typical capabilities of a router of this kind include declarative route configuration, nested and named routes, dynamic path parameters, programmatic navigation, navigation guards for access control or data loading, and scroll behavior control. The README itself does not enumerate these features in detail; it directs readers to the documentation site at v3.router.vuejs.org and to the examples directory in the repository.
Development is straightforward for contributors: install dependencies with yarn, build distribution files with yarn build, serve examples locally on port 8080 with yarn dev, run linting and the full test suite with yarn test, and serve the documentation with yarn docs. A release workflow is documented, covering test runs, versioned builds, changelog generation, committing dist files, tagging, and publishing to npm.
Support channels include a Discord chat server and the official Vue forum. The repository's issue tracker is reserved exclusively for bug reports and feature requests, and contributors are asked to read the issue reporting checklist and contributing guide before opening issues or pull requests. Release-by-release changes are recorded in CHANGELOG.md, and announcements are shared via the @vuejs Twitter account.
Because Vue 2 is no longer actively maintained, this package is best understood as a legacy dependency for existing Vue 2 applications rather than a choice for new projects. Teams starting fresh with Vue 3 should adopt Vue Router 4 instead.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.