zundo

🍜 Zundo

enable time-travel in your apps. undo/redo middleware for zustand. built with zustand. <700 B

Try a live demo

Install

npm i zustand zundo

zustand v4.2.0+ or v5 is required for TS usage. v4.0.0 or higher is required for JS usage. Node 16 or higher is required.

Background

• Solves the issue of managing state in complex user applications
• "It Just Works" mentality
• Small and fast
• Provides simple middleware to add undo/redo capabilities
• Leverages zustand for state management
• Works with multiple stores in the same app
• Has an unopinionated and extensible API

First create a vanilla store with temporal middleware

This returns the familiar store accessible by a hook! But now your store also tracks past states.

import { create } from 'zustand';
import { temporal } from 'zundo';

// Define the type of your store state (typescript)
interface StoreState {
  bears: number;
  increasePopulation: () => void;
  removeAllBears: () => void;
}

// Use `temporal` middleware to create a store with undo/redo capabilities
const useStoreWithUndo = create<StoreState>()(
  temporal((set) => ({
    bears: 0,
    increasePopulation: () => set((state) => ({ bears: state.bears + 1 })),
    removeAllBears: () => set({ bears: 0 }),
  })),
);

Then access temporal functions and properties of your store

Your zustand store will now have an attached temporal object that provides access to useful time-travel utilities, including undo, redo, and clear!

const App = () => {
  const { bears, increasePopulation, removeAllBears } = useStoreWithUndo();
  // See API section for temporal.getState() for all functions and
  // properties provided by `temporal`, but note that properties, such as `pastStates` and `futureStates`, are not reactive when accessed directly from the store.
  const { undo, redo, clear } = useStoreWithUndo.temporal.getState();

  return (
    <>
      bears: {bears}
      <button onClick={() => increasePopulation}>increase</button>
      <button onClick={() => removeAllBears}>remove</button>
      <button onClick={() => undo()}>undo</button>
      <button onClick={() => redo()}>redo</button>
      <button onClick={() => clear()}>clear</button>
    </>
  );
};

For reactive changes to member properties of the temporal object, optionally convert to a React store hook

In React, to subscribe components or custom hooks to member properties of the temporal object (like the array of pastStates or currentStates), you can create a useTemporalStore hook.

import { useStoreWithEqualityFn } from 'zustand/traditional';
import type { TemporalState } from 'zundo';

function useTemporalStore(): TemporalState<MyState>;
function useTemporalStore<T>(selector: (state: TemporalState<MyState>) => T): T;
function useTemporalStore<T>(
  selector: (state: TemporalState<MyState>) => T,
  equality: (a: T, b: T) => boolean,
): T;
function useTemporalStore<T>(
  selector?: (state: TemporalState<MyState>) => T,
  equality?: (a: T, b: T) => boolean,
) {
  return useStoreWithEqualityFn(useStoreWithUndo.temporal, selector!, equality);
}

const App = () => {
  const { bears, increasePopulation, removeAllBears } = useStoreWithUndo();
  // changes to pastStates and futureStates will now trigger a reactive component rerender
  const { undo, redo, clear, pastStates, futureStates } = useTemporalStore(
    (state) => state,
  );

  return (
    <>
      <p> bears: {bears}</p>
      <p> pastStates: {JSON.stringify(pastStates)}</p>
      <p> futureStates: {JSON.stringify(futureStates)}</p>
      <button onClick={() => increasePopulation}>increase</button>
      <button onClick={() => removeAllBears}>remove</button>
      <button onClick={() => undo()}>undo</button>
      <button onClick={() => redo()}>redo</button>
      <button onClick={() => clear()}>clear</button>
    </>
  );
};

API

The Middleware

(config: StateCreator, options?: ZundoOptions) => StateCreator

zundo has one export: temporal. It is used as middleware for create from zustand. The config parameter is your store created by zustand. The second options param is optional and has the following API.

Bear's eye view

export interface ZundoOptions<TState, PartialTState = TState> {
  partialize?: (state: TState) => PartialTState;
  limit?: number;
  equality?: (pastState: PartialTState, currentState: PartialTState) => boolean;
  diff?: (
    pastState: Partial<PartialTState>,
    currentState: Partial<PartialTState>,
  ) => Partial<PartialTState> | null;
  onSave?: (pastState: TState, currentState: TState) => void;
  handleSet?: (
    handleSet: StoreApi<TState>['setState'],
  ) => StoreApi<TState>['setState'];
  pastStates?: Partial<PartialTState>[];
  futureStates?: Partial<PartialTState>[];
  wrapTemporal?: (
    storeInitializer: StateCreator<
      _TemporalState<TState>,
      [StoreMutatorIdentifier, unknown][],
      []
    >,
  ) => StateCreator<
    _TemporalState<TState>,
    [StoreMutatorIdentifier, unknown][],
    [StoreMutatorIdentifier, unknown][]
  >;
}

Exclude fields from being tracked in history

partialize?: (state: TState) => PartialTState

Use the partialize option to omit or include specific fields. Pass a callback that returns the desired fields. This can also be used to exclude fields. By default, the entire state object is tracked.

// Only field1 and field2 will be tracked
const useStoreWithUndoA = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      partialize: (state) => {
        const { field1, field2, ...rest } = state;
        return { field1, field2 };
      },
    },
  ),
);

// Everything besides field1 and field2 will be tracked
const useStoreWithUndoB = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      partialize: (state) => {
        const { field1, field2, ...rest } = state;
        return rest;
      },
    },
  ),
);

useTemporalStore with partialize

If converting temporal store to a React Store Hook with typescript, be sure to define the type of your partialized state

interface StoreState {
  bears: number;
  untrackedStateField: number;
}

type PartializedStoreState = Pick<StoreState, 'bears'>;

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      bears: 0,
      untrackedStateField: 0,
    }),
    {
      partialize: (state) => {
        const { bears } = state;
        return { bears };
      },
    },
  ),
);

const useTemporalStore = <T,>(
  // Use partalized StoreState type as the generic here
  selector: (state: TemporalState<PartializedStoreState>) => T,
) => useStore(useStoreWithUndo.temporal, selector);

Limit number of historical states stored

limit?: number

For performance reasons, you may want to limit the number of previous and future states stored in history. Setting limit will limit the number of previous and future states stored in the temporal store. When the limit is reached, the oldest state is dropped. By default, no limit is set.

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    { limit: 100 },
  ),
);

Prevent unchanged states from getting stored in history

equality?: (pastState: PartialTState, currentState: PartialTState) => boolean

By default, a state snapshot is stored in temporal history when any zustand state setter is called—even if no value in your zustand store has changed.

If all of your zustand state setters modify state in a way that you want tracked in history, this default is sufficient.

However, for more precise control over when a state snapshot is stored in zundo history, you can provide an equality function.

You can write your own equality function or use something like fast-equals, fast-deep-equal, zustand/shallow, lodash.isequal, or underscore.isEqual.

Example with deep equality

import isDeepEqual from 'fast-deep-equal';

// Use a deep equality function to only store history when currentState has changed
const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    // a state snapshot will only be stored in history when currentState is not deep-equal to pastState
    // Note: this can also be more concisely written as {equality: isDeepEqual}
    {
      equality: (pastState, currentState) =>
        isDeepEqual(pastState, currentState),
    },
  ),
);

Example with shallow equality

If your state or specific application does not require deep equality (for example, if you're only using non-nested primitives), you may for performance reasons choose to use a shallow equality fn that does not do deep comparison.

import shallow from 'zustand/shallow';

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    // a state snapshot will only be stored in history when currentState is not deep-equal to pastState
    // Note: this can also be more concisely written as {equality: shallow}
    {
      equality: (pastState, currentState) => shallow(pastState, currentState),
    },
  ),
);

Example with custom equality

You can also just as easily use custom equality functions for your specific application

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      // Only track history when field1 AND field2 diverge from their pastState
      // Why would you do this? I don't know! But you can do it!
      equality: (pastState, currentState) =>
        pastState.field1 !== currentState.field1 &&
        pastState.field2 !== currentState.field2,
    },
  ),
);

Store state delta rather than full object

diff?: (pastState: Partial<PartialTState>, currentState: Partial<PartialTState>) => Partial<PartialTState> | null

For performance reasons, you may want to store the state delta rather than the complete (potentially partialized) state object. This can be done by passing a diff function. The diff function should return an object that represents the difference between the past and current state. By default, the full state object is stored.

If diff returns null, the state change will not be tracked. This is helpful for a conditionally storing past states or if you have a doNothing action that does not change the state.

You can write your own or use something like microdiff, just-diff, or deep-object-diff.

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      diff: (pastState, currentState) => {
        const myDiff = diff(currentState, pastState);
        const newStateFromDiff = myDiff.reduce(
          (acc, difference) => {
            type Key = keyof typeof currentState;
            if (difference.type === 'CHANGE') {
              const pathAsString = difference.path.join('.') as Key;
              acc[pathAsString] = difference.value;
            }
            return acc;
          },
          {} as Partial<typeof currentState>,
        );
        return isEmpty(newStateFromDiff) ? null : newStateFromDiff;
      },
    },
  ),
);

Callback when temporal store is updated

onSave?: (pastState: TState, currentState: TState) => void

Sometimes, you may need to call a function when the temporal store is updated. This can be configured using onSave in the options, or by programmatically setting the callback if you need lexical context (see the TemporalState API below for more information).

import { shallow } from 'zustand/shallow';

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    { onSave: (state) => console.log('saved', state) },
  ),
);

Cool-off period

  handleSet?: (handleSet: StoreApi<TState>['setState']) => (
    pastState: Parameters<StoreApi<TState>['setState']>[0],
    // `replace` will likely be deprecated and removed in the future
    replace: Parameters<StoreApi<TState>['setState']>[1],
    currentState: PartialTState,
    deltaState?: Partial<PartialTState> | null,
) => void

Sometimes multiple state changes might happen in a short amount of time and you only want to store one change in history. To do so, we can utilize the handleSet callback to set a timeout to prevent new changes from being stored in history. This can be used with something like throttle-debounce, just-throttle, just-debounce-it, lodash.throttle, or lodash.debounce. This a way to provide middleware to the temporal store's setter function.

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      handleSet: (handleSet) =>
        throttle<typeof handleSet>((state) => {
          console.info('handleSet called');
          handleSet(state);
        }, 1000),
    },
  ),
);

Initialize temporal store with past and future states

pastStates?: Partial<PartialTState>[]

futureStates?: Partial<PartialTState>[]

You can initialize the temporal store with past and future states. This is useful when you want to load a previous state from a database or initialize the store with a default state. By default, the temporal store is initialized with an empty array of past and future states.

Note: The pastStates and futureStates do not respect the limit set in the options. If you want to limit the number of past and future states, you must do so manually prior to initializing the store.

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      pastStates: [{ field1: 'value1' }, { field1: 'value2' }],
      futureStates: [{ field1: 'value3' }, { field1: 'value4' }],
    },
  ),
);

Wrap temporal store

wrapTemporal?: (storeInitializer: StateCreator<_TemporalState<TState>, [StoreMutatorIdentifier, unknown][], []>) => StateCreator<_TemporalState<TState>, [StoreMutatorIdentifier, unknown][], [StoreMutatorIdentifier, unknown][]>

You can wrap the temporal store with your own middleware. This is useful if you want to add additional functionality to the temporal store. For example, you can add persist middleware to the temporal store to persist the past and future states to local storage.

For a full list of middleware, see zustand middleware and third-party zustand libraries.

Note: The temporal middleware can be added to the temporal store. This way, you could track the history of the history. 🤯

import { persist } from 'zustand/middleware';

const useStoreWithUndo = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      wrapTemporal: (storeInitializer) =>
        persist(storeInitializer, { name: 'temporal-persist' }),
    },
  ),
);

useStore.temporal

When using zustand with the temporal middleware, a temporal object is attached to your vanilla or React-based store. temporal is a vanilla zustand store: see StoreApi from zustand for more details.

Use temporal.getState() to access to temporal store!

While setState, subscribe, and destroy exist on temporal, you should not need to use them.

useStore.temporal.getState()

temporal.getState() returns the TemporalState which contains undo, redo, and other helpful functions and fields.

interface TemporalState<TState> {
  pastStates: TState[];
  futureStates: TState[];

  undo: (steps?: number) => void;
  redo: (steps?: number) => void;
  clear: () => void;

  isTracking: boolean;
  pause: () => void;
  resume: () => void;

  setOnSave: (onSave: onSave<TState>) => void;
}

Going back in time

pastStates: TState[]

pastStates is an array of previous states. The most recent previous state is at the end of the array. This is the state that will be applied when undo is called.

Forward to the future

futureStates: TState[]

futureStates is an array of future states. States are added when undo is called. The most recent future state is at the end of the array. This is the state that will be applied when redo is called. The future states are the "past past states."

Back it up

undo: (steps?: number) => void

undo: call function to apply previous state (if there are previous states). Optionally pass a number of steps to undo to go back multiple state at once.

Take it back now y'all

redo: (steps?: number) => void

redo: call function to apply future state (if there are future states). Future states are "previous previous states." Optionally pass a number of steps to redo go forward multiple states at once.

Remove all knowledge of time

clear: () => void

clear: call function to remove all stored states from your undo store. Sets pastStates and futureStates to arrays with length of 0. Warning: clearing cannot be undone.

Dispatching a new state will clear all of the future states.

Stop and start history

isTracking: boolean

isTracking: a stateful flag in the temporal store that indicates whether the temporal store is tracking state changes or not. Possible values are true or false. To programmatically pause and resume tracking, use pause() and resume() explained below.

Pause tracking of history

pause: () => void

pause: call function to pause tracking state changes. This will prevent new states from being stored in history within the temporal store. Sets isTracking to false.

Resume tracking of history

resume: () => void

resume: call function to resume tracking state changes. This will allow new states to be stored in history within the temporal store. Sets isTracking to true.

Programmatically add middleware to the setter

setOnSave: (onSave: (pastState: State, currentState: State) => void) => void

setOnSave: call function to set a callback that will be called when the temporal store is updated. This can be used to call the temporal store setter using values from the lexical context. This is useful when needing to throttle or debounce updates to the temporal store.

Community

zundo is used by several projects and teams including Stability AI, Yext, KaotoIO, and NutSH.ai.

If this library is useful to you, please consider sponsoring the project. Thank you!

PRs are welcome! pnpm is used as a package manager. Run pnpm install to install local dependencies. Thank you for contributing!

Examples

• Basic
• with lodash.debounce
• with just-debounce-it
• SubscribeWithSelector
• canUndo, canRedo, undoDepth, redoDepth
• with deep equal
• with input

Migrate from v1 to v2

Click to expand

v2.0.0 - Smaller and more flexible

v2.0.0 is a complete rewrite of zundo. It is smaller and more flexible. It also has a smaller bundle size and allows you to opt into specific performance trade-offs. The API has changed slightly. See the API section for more details. Below is a summary of the changes as well as steps to migrate from v1 to v2.

Breaking Changes

Middleware Option Changes

• include and exclude options are now handled by the partialize option.
• allowUnchanged option is now handled by the equality option. By default, all state changes are tracked. In v1, we bundled lodash.isequal to handle equality checks. In v2, you are able to use any function.
• historyDepthLimit option has been renamed to limit.
• coolOffDurationMs option is now handled by the handleSet option by wrapping the setter function with a throttle or debounce function.

Import changes

• The middleware is called temporal rather than undoMiddleware.

New Features

New Options

• partialize option to omit or include specific fields. By default, the entire state object is tracked.
• limit option to limit the number of previous and future states stored in history.
• equality option to use a custom equality function to determine when a state change should be tracked. By default, all state changes are tracked.
• diff option to store state delta rather than full object.
• onSave option to call a function when the temporal store is updated.
• handleSet option to throttle or debounce state changes.
• pastStates and futureStates options to initialize the temporal store with past and future states.
• wrapTemporal option to wrap the temporal store with middleware. The temporal store is a vanilla zustand store.

New temporal.getState() API

• undo, redo, and clear functions are now always defined. They can no longer be undefined.
• undo() and redo() functions now accept an optional steps parameter to go back or forward multiple states at once.
• isTracking flag, and pause, and resume functions are now available on the temporal store.
• setOnSave function is now available on the temporal store to change the onSave behavior after the store has been created.

Migration Steps

1. Update zustand to v4.3.0 or higher
2. Update zundo to v2.0.0 or higher
3. Update your store to use the new API
4. Update imports

- import { undoMiddleware } from 'zundo';
+ import { temporal } from 'zundo';

• If you're using include or exclude, use the new partialize option

// v1.6.0
// Only field1 and field2 will be tracked
const useStoreA = create<StoreState>()(
  undoMiddleware(
    set => ({ ... }),
    { include: ['field1', 'field2'] }
  )
);

// Everything besides field1 and field2 will be tracked
const useStoreB = create<StoreState>()(
  undoMiddleware(
    set => ({ ... }),
    { exclude: ['field1', 'field2'] }
  )
);

// v2.0.0
// Only field1 and field2 will be tracked
const useStoreA = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      partialize: (state) => {
        const { field1, field2, ...rest } = state;
        return { field1, field2 };
      },
    },
  ),
);

// Everything besides field1 and field2 will be tracked
const useStoreB = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    {
      partialize: (state) => {
        const { field1, field2, ...rest } = state;
        return rest;
      },
    },
  ),
);

• If you're using allowUnchanged, use the new equality option

// v1.6.0
// Use an existing `allowUnchanged` option
const useStore = create<StoreState>()(
  undoMiddleware(
    set => ({ ... }),
    { allowUnchanged: true }
  )
);

// v2.0.0
// Use an existing equality function
import { shallow } from 'zustand/shallow'; // or use `lodash.isequal` or any other equality function

// Use an existing equality function
const useStoreA = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    { equality: shallow },
  ),
);

• If you're using historyDepthLimit, use the new limit option

// v1.6.0
// Use an existing `historyDepthLimit` option
const useStore = create<StoreState>()(
  undoMiddleware(
    set => ({ ... }),
    { historyDepthLimit: 100 }
  )
);

// v2.0.0
// Use `limit` option
const useStore = create<StoreState>()(
  temporal(
    (set) => ({
      // your store fields
    }),
    { limit: 100 },
  ),
);

• If you're using coolOffDurationMs, use the new handleSet option

// v1.6.0
// Use an existing `coolOffDurationMs` option
const useStore = create<StoreState>()(
  undoMiddleware(
    set => ({ ... }),
    { coolOfDurationMs: 1000 }
  )
);

// v2.0.0
// Use `handleSet` option
const withTemporal = temporal<MyState>(
  (set) => ({
    // your store fields
  }),
  {
    handleSet: (handleSet) =>
      throttle<typeof handleSet>((state) => {
        console.info('handleSet called');
        handleSet(state);
      }, 1000),
  },
);

Road Map

• create nicer API, or a helper hook in react land (useTemporal). or vanilla version of the it
• support history branches rather than clearing the future states
• track state for multiple stores at once

Author

Charles Kornoelje (@_charkour)

Versioning

View the releases for the change log. This project follows semantic versioning.

Illustration Credits

Ivo Ilić (@theivoson)