Skip to content
🚦 The official router for Vue.js.
JavaScript TypeScript Shell
Branch: dev
Clone or download
Latest commit 256cf3e Jan 15, 2020
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: use yarn Jun 10, 2019
.github chore: add funding.yml Aug 23, 2019
assets chore: add browserstack logo (#2709) Apr 12, 2019
build chore: upgrade rollup Aug 23, 2019
dist build: bundle 3.1.5 Jan 15, 2020
docs-gitbook docs: use string params in examples (#2269) Dec 2, 2018
docs docs(ja): remove extra space (#3098) Jan 13, 2020
examples fix(view): add passing props to inactive component (#2773) Jan 15, 2020
flow chore(flow): Add link exact active class to router options (#2236) Jun 2, 2018
scripts chore: remove redundant push Aug 30, 2019
src fix(view): add passing props to inactive component (#2773) Jan 15, 2020
test fix(view): add passing props to inactive component (#2773) Jan 15, 2020
types test(types): add test for props #2768 Jan 14, 2020
.eslintignore chore: add eslintignore Apr 8, 2019
.eslintrc update eslint config Jun 2, 2017
.flowconfig chore(flow): update flow-bin Mar 18, 2018
.gitignore ci: add ie via browserstack Jun 8, 2019
.prettierrc chore: add prettierrc Jun 10, 2019 chore(changelog): 3.1.5 Jan 15, 2020
LICENSE Avoid updating license every year (#1957) Dec 31, 2017 chore: Fix typo (#2858) Jul 20, 2019
package.json chore(release): 3.1.5 Jan 15, 2020
yarn.lock fix(view): fix deeply nested keep-alive router-views displaying (#2930) Jan 14, 2020

vue-router Build Status

This is vue-router 3.0 which works only with Vue 2.0. For the 1.x router see the 1.0 branch.


vue-router is the official router for Vue.js. It deeply integrates with Vue.js core to make building Single Page Applications with Vue.js a breeze. Features include:

  • Nested route/view mapping
  • Modular, component-based router configuration
  • Route params, query, wildcards
  • View transition effects powered by Vue.js' transition system
  • Fine-grained navigation control
  • Links with automatic active CSS classes
  • HTML5 history mode or hash mode, with auto-fallback in IE9
  • Customizable Scroll Behavior

Get started with the documentation, or play with the examples (see how to run them below).

Development Setup

# install deps
npm install

# build dist files
npm run build

# serve examples at localhost:8080
npm run dev

# lint & run all tests
npm test

# serve docs at localhost:8080
npm run docs


  • yarn run release
    • Ensure tests are passing yarn run test
    • Build dist files VERSION=<the_version> yarn run build
    • Build changelog yarn run changelog
    • Commit dist files git add dist && 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


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.


Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.


Please make sure to read the Contributing Guide before making a pull request.


Details changes for each release are documented in the release notes.

Stay In Touch

  • For latest releases and announcements, follow on Twitter: @vuejs



Copyright (c) 2013-present Evan You

Special Thanks

BrowserStack Logo

Special thanks to BrowserStack for letting the maintainers use their service to debug browser specific issues.

You can’t perform that action at this time.