Pinia Plugin Persistedstate

Theme by Prazdevs

|

Updated: 10 May 2025

|

2364 Stars

Configurable persistence and rehydration of Pinia stores.

Categories

Overview

The Pinia Plugin PersistedState is a tool that allows users to persist Pinia stores with a user-friendly API. It is highly customizable and compatible with various frameworks. Additionally, it is a lightweight package with no external dependencies, making it an efficient and convenient choice for developers.

Features

• Persist Pinia stores: The plugin enables users to persist Pinia stores with ease, using a simple API inspired by vuex-persistedstate.
• Customizable: Users can customize their storage options, serializer, and paths picking according to their preferences.
• Compatibility: The Pinia Plugin PersistedState is compatible with any framework that uses Pinia.
• Lightweight: With a package size of less than 1kB gzipped, the plugin is lightweight and efficient.

Installation

To install the Pinia Plugin PersistedState, follow these steps:

1. Install the plugin using your preferred package manager:

   • For pnpm: pnpm i pinia-plugin-persistedstate
   • For npm: npm i pinia-plugin-persistedstate
   • For yarn: yarn add pinia-plugin-persistedstate

2. Add the plugin to your Pinia configuration.

3. Define the persist option for the store you want to persist.

Example Configuration

// Add the plugin to Pinia
import { createPinia } from 'pinia';
import { persist } from 'pinia-plugin-persistedstate';

const pinia = createPinia();
pinia.use(persist);

// Define persist options for a store
pinia.persist({
  store: yourStore,
  key: 'yourStoreKey',
  storage: localStorage
});

For detailed configuration options, please refer to the official documentation.

Summary

The Pinia Plugin PersistedState is a powerful tool for persisting Pinia stores with a user-friendly API. It offers customization options, compatibility with various frameworks, and a lightweight package size. By using this plugin, developers can easily persist Pinia stores and enhance the efficiency of their applications.