PersistAndSync Zustand Store

Zustand middleware to easily persist and sync Zustand state between tabs / windows / iframes (Same Origin)

Motivation: Recently I got cought up in several issues working with persist miggleware and syncing tabs with zustand. This is a simple light weight middleware to persist and instantly share state between tabs or windows

• ✅ 🐙 (642 Bytes gZiped) ~ 0.5 kB size cross-tab state sharing + persistance for zustand
• ✅ Full TypeScript Support
• ✅ solid reliability in 1 writing and n reading tab-scenarios (with changing writing tab)
• ✅ Fire and forget approach of always using the latest state. Perfect for single user systems
• ✅ Share state between multiple browsing contexts

Install

$ pnpm add persist-and-sync
# or
$ npm install persist-and-sync
# or
$ yarn add persist-and-sync

Usage

Simply add the middleware while creating the store and the rest will be taken care.

import { create } from "zustand";
import { persistNSync } from "persist-and-sync";

type MyStore = {
    count: number;
    set: (n: number) => void;
};

const useStore = create<MyStore>(
    persistNSync(
        set => ({
            count: 0,
            set: n => set({ count: n }),
        }),
        { name: "my-channel" },
    ),
);

⚡🎉Boom! Just a couple of lines and your state perfectly syncs between tabs/windows and it is also persisted using localStorage!

Advanced - ignore / filter out fields based on regExp

In several cases you might want to exclude several fields from syncing. To support this scenario, we provide a mechanism to exclude fields based on regExp. Just pass regExpToIgnore (optional - default -> undefined) in options object.

// to ignore fields containing a slug
persistNSync(
    set => ({
      count: 0,
      slugSomeState: 1,
      slugSomeState2: 1,
      set: n => set({ count: n }),
    }),
    { name: "my-channel", regExpToIgnore: /slug/ },
    // or regExpToIgnore: new RegExp('slug')
    // Use full power of regExp by adding `i` and `g` flags
  ),

For more details about regExp check out - JS RegExp

Exact match

For exactly matching a parameter/field use /^your-field-name$/. ^ forces match from the first caracter and similarly, $ forces match until last character.

Ignore multiple fields with exact match

use regExpToIgnore: /^(field1|field2|field3)$/

Roadmap

• regExpToInclude -> once implemented, passing this parameter will sync only matching fields

🤩 Don't forger to start this repo!

Want handson course for getting started with Turborepo? Check out React and Next.js with TypeScript and The Game of Chess with Next.js, React and TypeScrypt

License

Licensed as MIT open source.

with 💖 by Mayank Kumar Chaudhari