pinia-persistedstate-plugin

English | 中文

A pinia plugin like vuex-persistedstate.

Install

1npm install pinia-persistedstate-plugin

or

1yarn add pinia-persistedstate-plugin

or

1pnpm add pinia-persistedstate-plugin

The UMD build is also available on unpkg:

1<script src="https://unpkg.com/pinia-persistedstate-plugin/dist/pinia-persistedstate-plugin.umd.js"></script>

You can find the library on window.PiniaPersistedstatePlugin.

Usage

In main.ts:

1import { createApp } from 'vue'
2import { createPinia } from 'pinia'
3import { createPersistedState } from 'pinia-persistedstate-plugin'
4import App from './App.vue'
5
6const app = createApp(App)
7const store = createPinia()
8
9store.use(createPersistedState())
10
11app.use(store).mount('#app')

use js-cookie

1import { createApp } from 'vue'
2import { createPinia } from 'pinia'
3import { createPersistedState } from 'pinia-persistedstate-plugin'
4import App from './App.vue'
5import Cookies from 'js-cookie'
6
7const app = createApp(App)
8const store = createPinia()
9
10store.use(
11  createPersistedState({
12    storage: Cookies
13  })
14)
15
16app.use(store).mount('#app')

Options

1export interface Options {
2  /**
3   * storage, default is `window.localStorage`
4   *
5   * support `js-cookie` `window.localStorage` `window.sessionStorage`
6   */
7  storage?: Storage | Cookies
8  /**
9   * storage key prefix, default is `pinia`
10   */
11  key: string
12  /**
13   * is open logger, default is `false`
14   */
15  logger: boolean
16}

License

MIT License.