Skip to content
Persist and rehydrate your Vuex store via url search params (window.location.search)
JavaScript
Branch: master
Clone or download
Latest commit 34541c6 Jan 23, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
__tests__ feat: Tests and docs Apr 21, 2019
lib refactor: Add Vuex store object as argument for modifiers functions Apr 21, 2019
src
.babelrc feat: Tests and docs Apr 21, 2019
.eslintignore
.eslintrc.js fix: ESLint rules Jan 23, 2020
.gitignore
.travis.yml
LICENSE Initial commit Apr 17, 2019
README.md chore: Add Travis CI Jan 16, 2020
package-lock.json
package.json chore: Bump version Jan 23, 2020
rollup.config.js
yarn.lock

README.md

Vuex URL Search Params

License Build Status Coverage Status

Description

Persist and rehydrate your Vuex store via url search params (window.location.search).

Installation

npm i --save vuex-url-search-params
# or
yarn add vuex-url-search-params

Testing

npm i --no-save vue@2.x vue-template-compiler@2.x vuex@3.x # Optionally
yarn test:jest # Runs Jest with coverage collection
yarn test:coverage # Sends coverage to .coveralls.io
yarn test # yarn test:jest && yarn test:coverage

Usage

Look at the quite complex example at CodeSandbox:

Edit vuex-url-search-params

Configuring

Note, this plugin is now suitable only for array-like and iterable Vuex state values!

Options

subscribeTo = [] <Array>

Mutations types for subscribing.

modifiers = {} <Object>

Object which defines how to <mutationType> payload will be transform to the query string search param and back

modifiers.<mutationType>.key <String>

Query string search param name

modifiers.<mutationType>.pushStateModifier <Function>

Function for modifying mutation payload value for using it in a query string search param with key above. Accepts <mutationType> payload as the first argument and Vuex store object as the second

modifiers.<mutationType>.popStateModifier <Function>

Function for modifying query string search param value for using it in an appropriate mutation. Accepts query string search param value as the first argument and Vuex store object as the second

modifiers.<mutationType>.emptyStateModifier <Function>

Function which result will be used as payload value for mutation when an appropriate query string search param become empty. Accepts Vuex store object as argument

qs = window.location.search <String>

Query string for initialization

store <Vuex.Store>

Vuex store object

You can’t perform that action at this time.