Github url

vue-router

by vuejs

vuejs /vue-router

🚦 The official router for Vue.js.

16.7K Stars 4.6K Forks Last release: 26 days ago (v3.3.4) MIT License 1.1K Commits 74 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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.

Introduction

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

Releasing

  • yarn run release
    • Ensure tests are passing
      yarn run test
    • Build dist files
      VERSION=<the_version> yarn run build</the_version>
    • 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 release notes.

Stay In Touch

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

License

MIT

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.