vuex-persistedstate

by robinvdvleuten

robinvdvleuten / vuex-persistedstate

πŸ’Ύ Persist and rehydrate your Vuex state between page reloads.

4.7K Stars 278 Forks Last release: 3 months ago (v3.1.0) MIT License 236 Commits 32 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

vuex-persistedstate

Persist and rehydrate your Vuex state between page reloads.


Build Status NPM version NPM downloads Prettier MIT license

PRs Welcome Code Of Conduct

Sponsored by The Webstronauts

Install

npm install --save vuex-persistedstate

The UMD build is also available on unpkg:


You can find the library on

window.createPersistedState
.

Usage

vuex-persistedstate 3.x (for Vuex 3 and Vue 2)

import Vuex from "vuex";
import createPersistedState from "vuex-persistedstate";

const store = new Vuex.Store({ // ... plugins: [createPersistedState()], });

vuex-persistedstate 4.x (for Vuex 4 and Vue 3)

import { createStore } from "vuex";
import createPersistedState from "vuex-persistedstate";

const store = createStore({ // ... plugins: [createPersistedState()], });

Examples

Check out a basic example on CodeSandbox.

Edit vuex-persistedstate

Or configured to use with js-cookie.

Edit vuex-persistedstate with js-cookie

Or configured to use with secure-ls

Edit vuex-persistedstate with secure-ls (encrypted data)

Example with Vuex modules

New plugin instances can be created in separate files, but must be imported and added to plugins object in the main Vuex file.

/* module.js */
export const dataStore = {
  state: {
    data: []
  }
}

/* store.js */ import { dataStore } from './module'

const dataState = createPersistedState({ paths: ['data'] })

export new Vuex.Store({ modules: { dataStore }, plugins: [dataState] })

Example with Nuxt.js

It is possible to use vuex-persistedstate with Nuxt.js. It must be included as a NuxtJS plugin:

With local storage (client-side only)

// nuxt.config.js

... /*

// ~/plugins/persistedState.client.js

import createPersistedState from 'vuex-persistedstate'

export default ({store}) => { createPersistedState({ key: 'yourkey', paths: [...] ... })(store) }

Using cookies (universal client + server-side)

Add

cookie
and
js-cookie
:

npm install --save cookie js-cookie
or
yarn add cookie js-cookie
// nuxt.config.js
...
plugins: [{ src: '~/plugins/persistedState.js'}]
...
// ~/plugins/persistedState.js

import createPersistedState from 'vuex-persistedstate'; import * as Cookies from 'js-cookie'; import cookie from 'cookie';

export default ({ store, req }) => { createPersistedState({ paths: [...], storage: { getItem: (key) => { // See https://nuxtjs.org/guide/plugins/#using-process-flags if (process.server) { const parsedCookies = cookie.parse(req.headers.cookie); return parsedCookies[key]; } else { return 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: 365, secure: false }), removeItem: key => Cookies.remove(key) } })(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 
    : The key to store the persisted state under. Defaults to
    vuex
    .
  • paths 
    : An array of any paths to partially persist the state. If no paths are given, the complete state is persisted. If an empty array is given, no state is persisted. Paths must be specified using dot notation. If using modules, include the module name. eg: "auth.user" Defaults to
    undefined
    .
  • reducer 
    : A function that will be called to reduce the state to persist based on the given paths. Defaults to include the values.
  • subscriber 
    : A function called to setup mutation subscription. Defaults to
    store => handler => store.subscribe(handler)
    .
  • storage 
    : Instead of (or in combination with)
    getState
    and
    setState
    . Defaults to localStorage.
  • getState 
    : A function that will be called to rehydrate a previously persisted state. Defaults to using
    storage
    .
  • setState 
    : A function that will be called to persist the given state. Defaults to using
    storage
    .
  • filter 
    : A function that will be called to filter any mutations which will trigger
    setState
    on storage eventually. Defaults to
    () => true
    .
  • overwrite 
    : When rehydrating, whether to overwrite the existing state with the output from
    getState
    directly, instead of merging the two objects with
    deepmerge
    . Defaults to
    false
    .
  • arrayMerger 
    : A function for merging arrays when rehydrating state. Defaults to
    function (store, saved) { return saved }
    (saved state replaces supplied state).
  • rehydrated 
    : 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 to
    store => {}
  • fetchBeforeUse 
    : A boolean indicating if the state should be fetched from storage before the plugin is used. Defaults to
    false
    .
  • assertStorage 
    : An overridable function to ensure storage is available, fired on plugins's initialization. Default one is performing a Write-Delete operation on the given Storage instance. Note, default behaviour could throw an error (like
    DOMException: QuotaExceededError
    ).

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);

Edit vuex-persistedstate with js-cookie

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.

Edit vuex-persistedstate with secure-ls (encrypted data)

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.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Robin van der Vleuten

πŸ’» πŸ“– πŸš‡ ⚠️

Sebastian

πŸ’» πŸ“–

Boris Graeff

πŸ’»

CΓ­cero Pablo

πŸ“–

Gurpreet Atwal

⚠️

Jakub Koralewski

πŸ’»

Jankees van Woezik

πŸ“–

Jofferson Ramirez Tiquez

πŸ“–

Jordan Deprez

πŸ“–

Juan Villegas

πŸ“–

JΓΌrg Rast

πŸ’»

Kartashov Alexey

πŸ’»

Leonard Pauli

πŸ’» πŸ“–

Nelson Liu

πŸ’» πŸ“– ⚠️

Nico

πŸ’» ⚠️

Quentin Dreyer

πŸ’»

Raphael Saunier

πŸ’»

Rodney Rehm

πŸ’» ⚠️

Ryan Wang

πŸ’» πŸ“– ⚠️

SΓ©bastien Chopin

πŸ“–

jeffjing

πŸ’»

macarthuror

πŸ“–

Paul Melero

πŸ“– πŸ’» ⚠️

Guillaume da Silva

πŸ’»

Jonathan Santerre

πŸ’»

FΓ‘bio Santos

πŸ“–

robertgr991

πŸ’»

JurijsKolesnikovs

πŸ“–

David Bond

πŸ“–

Freek van Rijt

πŸ“–

Ilyes Hermellin

πŸ’»

Peter Siska

πŸ“–

Dmitry Filippov

πŸ“–

Thomas Meitz

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

License

The MIT License (MIT). Please see License File for more information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.