rt2zz/redux-persist is a TypeScript project with 12.9k stars. persist and rehydrate a redux store
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Persist and rehydrate a redux store. Your state is saved to storage as it
changes and restored into the store when your app starts.
Hey all! redux-persist is maintained again, and v7 is in beta
(npm install redux-persist@next): Redux Toolkit 2 support with no extra
setup, a fix for stored data getting wiped
(#809), and lots
more. Please try it and tell us how it goes in
the v7 beta discussion.
These docs are for v7, which needs Redux 5 or Redux Toolkit 2. Upgrading
from 6? Read the migration guide; your stored
data carries over as is. For 6.x, see the
v6 docs.
Drop-in. Wrap your root reducer with persistReducer and call
persistStore. Nothing else in your app changes, and Redux Toolkit needs no
extra setup.
Any storage. localStorage and sessionStorage ship in the box;
AsyncStorage, IndexedDB, the filesystem and more plug in —
storage engines.
You choose what's saved. Allow or block keys, nest persisted reducers
for finer control, and transform state on the way in and out.
Versioned. Migrations upgrade stored state when its shape changes —
how migrations work.
Quickstart
npm install redux-persist
Wrap your root reducer and create a persistor alongside the store:
// app/store.ts
import { configureStore, combineReducers } from '@reduxjs/toolkit'
import { persistStore, persistReducer } from 'redux-persist'
import storage from 'redux-persist/storage' // localStorage on the web
import userReducer from './features/user/userSlice'
import configReducer from './features/config/configSlice'
const rootReducer = combineReducers({
user: userReducer,
config: configReducer
})
const persistConfig = {
key: 'root',
version: 1,
storage,
}
const persistedReducer = persistReducer(persistConfig, rootReducer)
export const store = configureStore({
reducer: persistedReducer,
})
export const persistor = persistStore(store)
If you use React, wrap your root component in
PersistGate. It holds off rendering until the stored
state has been loaded back into redux. loading can be null or any React
element, e.g. loading={<Loading />}.
import { PersistGate } from 'redux-persist/react'
import { store, persistor } from './app/store'
// ... normal setup, import components etc.
const App = () => {
return (
<Provider store={store}>
<PersistGate loading={null} persistor={persistor}>
<RootComponent />
</PersistGate>
</Provider>
);
};
If you'd rather not gate rendering, useRehydrated(persistor) from
redux-persist/react returns whether stored state has loaded.
Every app has to decide how many levels of stored state to merge into its
initial state. The default is one level; read
state reconcilers before you ship.
redux-persist/storage works during server rendering (Next.js and others): on
the server it stores nothing, and stored state is loaded in the browser. With
the Next.js App Router, render PersistGate from a Client Component; see
PersistGate.
Choosing what's saved
denylist and allowlist pick top-level keys:
persistReducer({ key: 'root', storage, denylist: ['navigation'] }, rootReducer) // navigation will not be persisted
persistReducer({ key: 'root', storage, allowlist: ['navigation'] }, rootReducer) // only navigation will be persisted
They're checked against your state's keys, so a typo is a type error. If you
declare the config separately, annotate it with PersistConfig<RootState> or
use as const on the array. The older names blacklist and whitelist still
work.
For keys you can't list ahead of time, pass a function that's called with each
top-level key:
persistReducer({ key: 'root', storage, denylist: key => key.startsWith('temp') }, rootReducer) // keys starting with temp will not be persisted
To go deeper than one level, use nested persists.
Resetting state on logout
Reset state inside the reducer you pass to persistReducer, so the reset
state is saved too:
The reset state is saved like any other change. To write it right away (for
example before the app might close), await persistor.flush() after
dispatching the action.
Don't reset above persistReducer (by wrapping the persisted reducer, or with
a store enhancer that replaces the whole state): that removes the _persist
key, so the state stops being saved, and the previous user's state is loaded
again on the next launch. redux-persist logs an error in development when this
happens.
Learn more
API — persistReducer, persistStore, the persistor, and config types
PersistGate — delaying render until rehydration finishes
State reconcilers — how stored state merges with initial state
Nested persists — per-branch storage, code splitting, deep filtering
Migrations — upgrading stored state between versions
Transforms — customizing what's serialized, and community transforms
Storage engines — built-in and community storage backends
Recipes — loading state later, state per user, syncing tabs, knowing when state was saved, encryption
Hot module replacement
Migrating from v6 to v7
Storage format — what's stored, and the compatibility promise
Migrating from v4 to v5
Contributing
Bug reports and pull requests are welcome; see CONTRIBUTING.md,
especially before changing anything that touches stored data. Questions and
feature ideas go in Discussions.
Feedback on the v7 beta goes in the v7 beta discussion.
The most recent commit recorded on rt2zz/redux-persist was 16 days ago, based on the GitHub push timestamp. The repository has 838 forks — one of the better signals of community interest.
How many stars does rt2zz/redux-persist have?
rt2zz/redux-persist has 12.9k GitHub stars — refresh the page for the live number, or check github.com/rt2zz/redux-persist. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is rt2zz/redux-persist open source?
Yes — rt2zz/redux-persist ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/rt2zz/redux-persist.
What is rt2zz/redux-persist?
rt2zz/redux-persist (rt2zz/redux-persist) is a TypeScript project on GitHub. From the project's own README: persist and rehydrate a redux store
Where do I read more about rt2zz/redux-persist?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/rt2zz/redux-persist is the definitive source.
Read full README in the tab above.
Curious whether redux-persist is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about redux-persist.