https://github.com/vuejs/router

🚦 The official router for Vue.js
https://github.com/vuejs/router

vue vue-router

Last synced: 1 day ago
JSON representation

🚦 The official router for Vue.js

• Host: GitHub
• URL: https://github.com/vuejs/router
• Owner: vuejs
• License: mit
• Created: 2019-02-07T18:09:43.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2025-04-25T13:04:52.000Z (12 days ago)
• Last Synced: 2025-04-27T20:54:14.140Z (9 days ago)
• Topics: vue, vue-router
• Language: TypeScript
• Homepage: https://router.vuejs.org/
• Size: 11 MB
• Stars: 4,201
• Watchers: 52
• Forks: 1,234
• Open Issues: 48
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing.md
  • Funding: .github/funding.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-github-star - router
• awesome-starred - vuejs/router - 🚦 The official router for Vue.js (vue)
• awesome-arsenal - Router - 路由。 (武器库 / 前端)

README

        
# vue-router [![release candidate](https://img.shields.io/npm/v/vue-router.svg)](https://www.npmjs.com/package/vue-router) [![test](https://github.com/vuejs/router/actions/workflows/test.yml/badge.svg)](https://github.com/vuejs/router/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/vuejs/router/graph/badge.svg?token=azNM3FI0d1)](https://codecov.io/gh/vuejs/router)

> - This is the repository for Vue Router 4 (for Vue 3)

> - For Vue Router 3 (for Vue 2) see [vuejs/vue-router](https://github.com/vuejs/vue-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](https://github.com/sponsors/posva)

- [One-time donation via PayPal](https://paypal.me/posva)

Gold Sponsors



    

    

      

      

    

  



Silver Sponsors



    

    

      

      

    

  

    

    

      

      

    

  

    

    

      

      

    

  



Bronze Sponsors



    

    

      

      

    

  

    

    

      

      

    

  

    

    

      

      

    

  



---

Get started with the [documentation](https://router.vuejs.org).

## Quickstart

- Via CDN: ``

- In-browser playground on [CodeSandbox](https://codesandbox.io/s/vue-router-4-reproduction-hb9lh)

- Add it to an existing Vue Project:

  ```bash

  npm install vue-router@4

  ```

## Changes from Vue Router 3

Please consult the [Migration Guide](https://router.vuejs.org/guide/migration/).

## Contributing

See [Contributing Guide](https://github.com/vuejs/router/blob/main/.github/contributing.md).

## Special Thanks



  



Special thanks to [BrowserStack](https://www.browserstack.com) for letting the maintainers use their service to debug browser specific issues.