zustand

This version has some improvements thanks to contributors: @MarshallOfSound @koreahghg @chungyo @Godsdar

What's Changed

• react: Don't memoize getServerSnapshot in useStore

• devtools: Apply serialize.reviver when parsing devtools messages

• devtools: Preserve shared connections during store cleanup

• persist: Preserve external devtools action arguments

Fix some issues in devtools and persist middleware.

What's Changed

• devtools: Correct V8 stack regex when source path contains spaces

• persist: clearStorage() should invalidate concurrent async rehydration

This release fixes a type issue in devtools.

What's Changed

• devtools: Improve type inference for Devtools initializer

This release includes an improvement in the devtools middleware.

What's Changed

• devtools: Support Firefox/Safari stack format in findCallerName

Two small fixes.

What's Changed

• persist: Use latest state in post-rehydration callback

• devtools: Correct redux devtools config type extension

This release includes small improvements in middleware thanks to contributors.

What's Changed

• persist: Avoid relying on global localStorage

• immer: Proper typing for immer middleware in combination with slices

This version includes a fix to the persist middleware for an edge case.

What's Changed

• persist: Prevent race condition during concurrent rehydrate calls

This includes experimental middleware unstable_ssrSafe for a new usage with Next.js.
Related discussion: github.com/pmndrs/zustand/discussions/2740

What's Changed

• experimental: Unstable ssrSafe middleware

A bug fix in shallow and a tiny improvement in persist.

What's Changed

• shallow: Undefined value

• middleare/persist: Return storage promise from setState

This enables a small optimization in some edge cases.

What's Changed

• react: useCallback for getSnapshot

Some very minor changes.

What's Changed

• devtools: Avoid inferring action type when explicit action name is provided

It comes with some small improvements.

What's Changed

• vanilla: Update shallow compare function and tests

• Add devtools.cleanup() method

• devtool: Inferred action type

This fixes module resolution issue for React Native users.

What's Changed

• package: react-native condition

ExtractState is a type util to extract state type from store type.

What's Changed

• types: Make ExtractState public

• build: Alias entries in rollup config

This fixes some issues in middleware.

What's Changed

• middleware: Devtools type error #2700

• persist: Fix async migrate on persist middleware

This fixes shallow function for some edge cases.

What's Changed

• shallow: Fallback map-like iterator comparison

• shallow: iterable-like insensitive keys order comparison (alternate implementation)

Zustand v5

TL;DR

• No new features

• Drop many old things

• Migration from v4 should be smooth.

Changes in v5

• removed

  Drop default exports

• removed

  Drop deprecated features

• breaking

  Make React 18 the minimum required version

• Make use-sync-external-store a peer dependency (required for createWithEqualityFn and useStoreWithEqualityFn in zustand/traditional)

• breaking

  Make TypeScript 4.5 the minimum required version

• Drop UMD/SystemJS support

• Organize entry points in the package.json

• Drop ES5 support

• Stricter types when setState's replace flag is set

• Persist middleware behavioral change

• Other small improvements (technically breaking changes)

Migration Guide

Read the migration guide carefully:
github.com/pmndrs/zustand/blob/main/docs/migrat…

Frequently Reported Issue

During the RC period, some users encountered the following infinite loop error:

Uncaught Error: Maximum update depth exceeded. This can happen when a component repeatedly calls setState inside componentWillUpdate or componentDidUpdate. React limits the number of nested updates to prevent infinite loops.

This case was already a non-ideal behavior in v4 but appears more explicitly as an error in v5. While there are several ways to resolve this, using useShallow often fixes the problem.

What's Changed

• v5

• Fix Immer type inference for setState

This improves the persist middleware behavior for an edge case.

:warning: We thought this was fixing a bug, but it actually introduced a behavioral breaking change. Please use v4.5.4 if the change is troublesome. See

What's Changed

• storage: Avoid calling setItem with the state just retrieved

There was an issue in v4.5.3 with some bundlers.

What's Changed

• No type field in package.json

It comes with a minor fix in types, but also some changes in configs.

What's Changed

• Migrate to pnpm

• useStore uses ReadonlyStoreApi

It should improve the compatibility with old browsers.

What's Changed

• Return type of persist migrate function changed to PersistedState

People might have misunderstood with useStore deprecation message. Hope this mitigates it.

What's Changed

• Relax types for persist middleware

This version adds a new capability for SSR/Hydration.

What's Changed

• getInitialState

• Add deprecation notice for getServerState() in WithReact type

There's a small fix for a use case with an non-object value in store.

What's Changed

• vanilla: Unexpected null state update behavior

v4.4.5 has an issue with some TypeScript configs about module resolution. It should be fixed now. Thanks for the patience.

What's Changed

• Update export types

Hopefully, it should fix some issues with Node.js environment including Next.js.

What's Changed

• Importing CJS React in ESM

• Apply publint recommendations

There was a tiny issue in v4.4.3, which broke with some bundlers, which this version fixes.

What's Changed

• build: Patch entry points zustand/shallow for CJS

The changes in v4.4.2 were troublesome for some users. This version should fix/mitigate such cases.

What's Changed

• shallow: Extract shallow vanilla and react

• types: Mitigate devtools typing

This adds useShallow hook to cover some use cases that are deprecated with v4.4.0 change. Check out the guide.

Migration Guide

#1991 requires something like below if you are using the devtools middleware and TypeScript.

  import { devtools } from 'zustand/middleware'
+ import type {} from '@redux-devtools/extension'

What's Changed

• fix(types)(middleware/devtools): avoid copying types

• traditional: Make defaultEqualityFn optional in TS Types

• Add useShallow

Fixes some issues reported with the deprecated feature in v4.4.0.

What's Changed

• types: Accept undefined equalityFn for the deprecated useStore

• deprecated

  Improve warning for deprecated equalityFn

This adds new zustand/traditional entry point and deprecates equalityFn from zustand.

Migration Guide

If you don't use custom equalityFn, nothing is required.

For those who use custom equalityFn such as shallow:

// previously
import { create } from 'zustand'
const useFooStore = create((set) => ...)

// now
import { createWithEqualityFn } from 'zustand/traditional'
const useFooStore = createWithEqualityFn((set) => ..., Object.is)
// Object.is is the default quailtyFn in zustand create; to match that behavior, pass that function here. This can be updated to shallow or anything else

What's Changed

• deprecated

  Deprecate equalityFn and add createWithEqualityFn

• Declare @types/react as peerDep to avoid phantom dep

This includes a small improvement for production build mostly for Vite users. Docs have been improved too!

What's Changed

• build: Mode env for "import" condition"

For persist middleware, a new option for createJSONStorage in introduced to support more cases. Note that createJSONStorage isn't a required function (and it's not very recommended as it's not type safe), and one should create a custom storage for more use cases.

What's Changed

• middleware/persist: Improve createJSONStorage for Maps

This includes a couple of improvements in persist middleware.

What's Changed

• middleware/persist: Add skip hydration option #405

• middleware/persist: Ensure persist does not drop updates in onRehydrateStorage when using a synchronous storage API

• middleware/persist: Ensure argument for onRehydrateStorage and onHydrate is defined on first hydration

This has a little improvement for library authors.

What's Changed

• react, types: Relax react types

v4.3.4 has a regression in CJS build. Please use this version instead.

What's Changed

• build: re-export createStore from index

This version fixes some build configs for some edge cases.

⚠️ this version has an issue in CJS build. Please use v4.3.5.

What's Changed

• build: UMD names

• build: Possibly improve ESM for production build

• build: Add explicit export paths for cjs

This version includes some small fixes and internal improvements.

What's Changed

• build: Improve patch scripts

• log: Deprecated messages copyedit for consistency

• build: Reorder the types field in package.json

There was a regression with default export (which is deprecated) in v4.3.0 and v4.3.1. This should fix it.

What's Changed

• vanilla,shallow: Default export regression in CJS

• middleware/persist: Fix the storage type

This version supersedes v4.3.0.

Throughout past years of development, we've learned the (mis)usage of the library. One of our goal is to provide smallest possible APIs. To go further, this version deprecates some features. They are still usable (with warnings), but will be removed in the future.

What's Changed

• deprecated

  Deprecate some APIs toward v5

• deprecated

  Deprecate default export

• middleware/persist: Hydrate in sync (new impl with storage option)

This version adds some new features in middleware.

What's Changed

• middleware/devtools: Better redux devtools. One connection for all zustand stores

• middleware/persist: New storage option

• build: Disable esModule and re-export for nodejs

This version has several small improvements.

What's Changed

• middleware/devtools: Do not use optional catch binding syntax

• shallow: Add support of Maps and Sets to shallow comparator

• Programmatic module.exports addition for named and default exports in CJS

This should improve some importing problems. Uncertain if it fixes everything.

What's Changed

• build: Use *.d.mts for esm ('import' condition only)

• build: No import.meta for "module" condition

This improves store types for TS users. We also upgrade rollup. Please report issues if anyone finds any.

What's Changed

• types: Assume getState and setState will always exist on the store

• types: Fix StateCreator subtyping

This includes some fixes for edge cases. Most notably, supporting old TypeScript versions.

What's Changed

• context: Store property missing from useStoreApi

• Should use Object.is to compare two value

• Rewrite TakeTwo, SkipTwo and Mutate to make them work for older ts versions too

In v4.1.0, there are some TypeScript type issues in redux and devtools middleware, which should be fixed.

What's Changed

• middleware: Revert types of redux middleware

• fix(types)(middleware/devtools): copy devtools option types instead of importing

This supports non-object state. It's probably one of the biggest changes in API design throughout the zustand development history. But, probably 99.9% of users won't use it 😝 .

What's Changed

• fix(types)(middleware/devtools): fix action type in devtools's setState

• vanilla: non-object state

• fix(types)(middleware): use official Config type for options