Effortlessly keep vue-router and vuex store in sync.
# 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@2import { sync } from 'vuex-router-sync'
import store from './vuex/store' // vuex store instance
import router from './router' // vue-router instance
sync(store, router) // done.
// bootstrap your app...You can set a custom vuex module name
sync(store, router, { moduleName: 'RouteModule' } )-
It adds a
routemodule into the store, which contains the state representing the current route: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.routeis 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.