pinia-persistedstate-plugin
English | 中文
A pinia plugin like vuex-persistedstate.
Install
npm install pinia-persistedstate-plugin
or
yarn add pinia-persistedstate-plugin
or
pnpm add pinia-persistedstate-plugin
The UMD build is also available on unpkg:
<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:
import { createApp } from 'vue'
import { createPinia } from 'pinia'
import { createPersistedState } from 'pinia-persistedstate-plugin'
import App from './App.vue'
const app = createApp(App)
const store = createPinia()
store.use(createPersistedState())
app.use(store).mount('#app')
use js-cookie
import { createApp } from 'vue'
import { createPinia } from 'pinia'
import { createPersistedState } from 'pinia-persistedstate-plugin'
import App from './App.vue'
import Cookies from 'js-cookie'
const app = createApp(App)
const store = createPinia()
store.use(
createPersistedState({
storage: Cookies
})
)
app.use(store).mount('#app')
Options
export interface Options {
/**
* storage, default is `window.localStorage`
*
* support `js-cookie` `window.localStorage` `window.sessionStorage`
*/
storage?: Storage | Cookies
/**
* storage key prefix, default is `pinia`
*/
key: string
/**
* is open logger, default is `false`
*/
logger: boolean
}
License
MIT License.
