vuejs /vue-router
🚦 The official router for Vue 2
★ 18,851⑂ 4,950👁 483⑃ 1,011● 2,858▤ 90
More from this author
-1
Daily
18,851
stars
4,950
forks
483
watchers
1,011
prs
2,858
issues
90
releases
README
vue-router
This is vue-router 3.0 which works only with Vue 2.0. and both have reached end of life.
- For the 1.x router see the 1.0 branch.
- For Vue Router 4 (for Vue 3) see vuejs/router.
Supporting Vue Router
Vue Router is part of the Vue Ecosystem and is an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
- Become a Sponsor on GitHub
- One-time donation via PayPal
Gold Sponsors
Silver Sponsors
Bronze Sponsors
---
Get started with the documentation, or play with the examples (see how to run them below).
Development Setup
bash
install deps
yarn
build dist files
yarn build
serve examples at localhost:8080
yarn dev
lint & run all tests
yarn test
serve docs at localhost:8080
yarn docs
Releasing
- yarn run release
- Ensure tests are passing yarn run test
- Build dist files VERSION= yarn run build
- Build changelog yarn run changelog
- Commit dist files git add dist CHANGELOG.md && git commit -m "[build $VERSION]"
- Publish a new version npm version $VERSION --message "[release] $VERSION"
- Push tags git push origin refs/tags/v$VERSION && git push
- Publish to npm npm publish
Questions
For questions and support please use the Discord chat server or the official forum. The issue list of this repo is exclusively for bug reports and feature requests.
Issues
Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.
Contribution
Please make sure to read the Contributing Guide before making a pull request.
Changelog
Details changes for each release are documented in the CHANGELOG.md file.
Stay In Touch
- For latest releases and announcements, follow on Twitter: @vuejs
License
MIT
Copyright (c) 2013-present Evan You
Special Thanks
Special thanks to BrowserStack for letting the maintainers use their service to debug browser specific issues.Top issues
#1234Remove existing routes44 comments · 2017-03-09#977change current component used by `router-view` without changing current URL43 comments · 2016-12-03#2648Allow defining an inactive-class41 comments · 2019-03-14#1187Need a way to set what scroll position is saved33 comments · 2017-02-22#2042Redirect on 404 page in google cache22 comments · 2018-02-02#2243Allow a user to read and write state on history entries (history.state)19 comments · 2018-06-05#1582beforeRouteUpdate never calls next callback17 comments · 2017-07-10#3027Add onComplete & onAbort to router-link16 comments · 2019-11-10
Latest release
v3.6.5 v3.6.5 2022-09-06Please refer to CHANGELOG.md for details.