https://github.com/vuejs/vuex-router-sync

Effortlessly keep vue-router and vuex store in sync.
https://github.com/vuejs/vuex-router-sync

vue vue-router vuex

Last synced: 3 days ago
JSON representation

Effortlessly keep vue-router and vuex store in sync.

• Host: GitHub
• URL: https://github.com/vuejs/vuex-router-sync
• Owner: vuejs
• License: mit
• Created: 2016-03-08T10:32:28.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-01-08T14:55:22.000Z (about 3 years ago)
• Last Synced: 2024-10-29T14:55:43.075Z (4 months ago)
• Topics: vue, vue-router, vuex
• Language: JavaScript
• Size: 402 KB
• Stars: 2,515
• Watchers: 48
• Forks: 125
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vue-js - Vuex Router-sync

README

        
# Vuex Router Sync

[![npm](https://img.shields.io/npm/v/vuex-router-sync.svg)](https://npmjs.com/package/vuex-router-sync)

[![ci status](https://github.com/vuejs/vuex-router-sync/workflows/test/badge.svg)](https://github.com/vuejs/vuex-router-sync/actions)

[![coverage](https://codecov.io/gh/vuejs/vuex-router-sync/branch/master/graph/badge.svg?token=4KJug3I5do)](https://codecov.io/gh/vuejs/vuex-router-sync)

[![license](https://img.shields.io/npm/l/vuex-router-sync.svg?sanitize=true)](http://opensource.org/licenses/MIT)

Sync Vue Router's current `$route` as part of Vuex store's state.

[中文版本 (Chinese Version)](README.zh-cn.md)

## Usage

``` bash

# the latest version works only with vue-router >= 2.0

npm install vuex-router-sync

# for usage with vue-router < 2.0:

npm install vuex-router-sync@2

```

``` js

import { sync } from 'vuex-router-sync'

import store from './store' // vuex store instance

import router from './router' // vue-router instance

const unsync = sync(store, router) // done. Returns an unsync callback fn

// bootstrap your app...

// During app/Vue teardown (e.g., you only use Vue.js in a portion of your app

// and you navigate away from that portion and want to release/destroy

// Vue components/resources)

unsync() // Unsyncs store from router

```

You can optionally set a custom vuex module name:

```js

sync(store, router, { moduleName: 'RouteModule' } )

```

## How does it work?

- It adds a `route` module into the store, which contains the state representing the current route:

  ``` js

  store.state.route.path   // current path (string)

  store.state.route.params // current params (object)

  store.state.route.query  // current query (object)

  ```

- When the router navigates to a new route, the store's state is updated.

- **`store.state.route` is immutable, because it is derived state from the URL, which is the source of truth**. You should not attempt to trigger navigations by mutating the route object. Instead, just call `$router.push()` or `$router.go()`. Note that you can do `$router.push({ query: {...}})` to update the query string on the current path.

## License

[MIT](http://opensource.org/licenses/MIT)