vuex-persistedstate
Persist and rehydrate your Vuex state between page reloads.
Requirements
Install
npm install --save vuex-persistedstate
The UMD build is also available on unpkg:
<script src="https://unpkg.com/vuex-persistedstate/dist/vuex-persistedstate.umd.js"></script>
You can find the library on window.createPersistedState
.
Usage
import createPersistedState from "vuex-persistedstate";
const store = new Vuex.Store({
// ...
plugins: [createPersistedState()]
});
Check out the example on CodeSandbox.
Or configured to use with js-cookie.
Or configured to use with secure-ls
Nuxt.js
It is possible to use vuex-persistedstate with Nuxt.js. Due to the order code is loaded in, vuex-persistedstate must be included as a NuxtJS plugin:
// nuxt.config.js
...
plugins: [{ src: '~/plugins/localStorage.js', ssr: false }]
...
// ~/plugins/localStorage.js
import createPersistedState from 'vuex-persistedstate'
export default ({store}) => {
window.onNuxtReady(() => {
createPersistedState({
key: 'yourkey',
paths: [...]
...
})(store)
})
}
API
createPersistedState([options])
Creates a new instance of the plugin with the given options. The following options can be provided to configure the plugin for your specific needs:
-
key <String>
: The key to store the persisted state under. (default: vuex) -
paths <Array>
: An array of any paths to partially persist the state. If no paths are given, the complete state is persisted. Paths must be specified using dot notation. If using modules, include the module name. eg: "auth.user" (default: []) -
reducer <Function>
: A function that will be called to reduce the state to persist based on the given paths. Defaults to include the values. -
subscriber <Function>
: A function called to setup mutation subscription. Defaults tostore => handler => store.subscribe(handler)
-
storage <Object>
: Instead for (or in combination with)getState
andsetState
. Defaults to localStorage. -
getState <Function>
: A function that will be called to rehydrate a previously persisted state. Defaults to usingstorage
. -
setState <Function>
: A function that will be called to persist the given state. Defaults to usingstorage
. -
filter <Function>
: A function that will be called to filter any mutations which will triggersetState
on storage eventually. Defaults to() => true
-
arrayMerger <Function>
: A function for merging arrays when rehydrating state. Defaults tofunction (store, saved) { return saved }
(saved state replaces supplied state). -
rehydrated <Function>
: A function that will be called when the rehydration is finished. Useful when you are using Nuxt.js, which the rehydration of the persisted state happens asynchronously. Defaults tostore => {}
Customize Storage
If it's not ideal to have the state of the Vuex store inside localstorage. One can easily implement the functionality to use cookies for that (or any other you can think of);
import { Store } from "vuex";
import createPersistedState from "vuex-persistedstate";
import * as Cookies from "js-cookie";
const store = new Store({
// ...
plugins: [
createPersistedState({
storage: {
getItem: key => Cookies.get(key),
// Please see https://github.com/js-cookie/js-cookie#json, on how to handle JSON.
setItem: (key, value) =>
Cookies.set(key, value, { expires: 3, secure: true }),
removeItem: key => Cookies.remove(key)
}
})
]
});
In fact, any object following the Storage protocol (getItem, setItem, removeItem, etc) could be passed:
createPersistedState({ storage: window.sessionStorage });
This is especially useful when you are using this plugin in combination with server-side rendering, where one could pass an instance of dom-storage.
🔐Encrypted Local Storage
If you need to use Local Storage (or you want to) but needs to protect the content of the data, you can encrypt it.
import { Store } from "vuex";
import createPersistedState from "vuex-persistedstate";
import SecureLS from "secure-ls";
var ls = new SecureLS({ isCompression: false });
// https://github.com/softvar/secure-ls
const store = new Store({
// ...
plugins: [
createPersistedState({
storage: {
getItem: key => ls.get(key),
setItem: (key, value) => ls.set(key, value),
removeItem: key => ls.remove(key)
}
})
]
});
⚠️ LocalForage ⚠️
As it maybe seems at first sight, it's not possible to pass a LocalForage instance as storage
property. This is due the fact that all getters and setters must be synchronous and LocalForage's methods are asynchronous.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
License
The MIT License (MIT). Please see License File for more information.