vue-router

The official router for Vue 2

VueRouting
vuejs/vue-routerv3.router.vuejs.org/vue-router

README

vue-router Build Status npm package bitHound Overall Score Issue Stats


Compatibility Note: vue-router requires Vue.js 0.12.10+ and currently does not support Vue.js 2.0.

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
- Restore scroll position when going back in history mode

Get started with the documentation.

Development Setup


  1. ``` bash
  2. # install deps
  3. npm install

  5. # build dist files
  6. npm run build

  8. # serve example app at localhost:8080
  9. npm run serve-example

  11. # and unit tests at localhost:8081
  12. npm run dev

  14. # lint & run all tests
  15. npm test

  17. # run unit tests only
  18. npm run unit

  20. # run e2e tests only
  21. npm run e2e-local
  22. ```

Questions


For questions and support please use the Gitter chat room or the official forum. The issue list of this repo isexclusively 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-2016 Evan You