react-undo-redo-state

useUndoRedoState

useUndoRedoState is a custom React hook that provides undo and redo functionality for state management. It allows you to easily integrate undo and redo capabilities into your React applications, giving users the ability to revert or reapply state changes with keyboard shortcuts or programmatic methods.

Features

• Keyboard Shortcuts: The hook automatically sets up event listeners for keyboard shortcuts (Cmd+Z for undo and Cmd+Shift+Z for redo on macOS, or Ctrl+Z and Ctrl+Shift+Z on other platforms).
• Programmatic Control: In addition to keyboard shortcuts, you can control undo and redo operations programmatically by calling the provided handleUndo and handleRedo functions.
• Customizable Stack Size: You can customize the maximum size of the undo and redo stacks to control memory usage.
• Callback Functions: The hook supports optional callback functions that are called after undo or redo operations, allowing you to perform additional actions or side effects.

Installation

You can install the package via npm or yarn:

npm install react-undo-redo-state

yarn add react-undo-redo-state

Usage

import React from 'react';
import { useUndoRedoState } from "react-undo-redo-state";

export default function CounterApp() {
  const [count, setCount] = useUndoRedoState(0);
  return (
    <div className="w-full h-screen mt-20">
      <div className="flex flex-col gap-5 items-center">
        <p className="text-2xl">{count}</p>
        <div className="flex items-center gap-5">
          <Button variant={"outline"} onClick={() => setCount(count - 1)}>
            - Decrement
          </Button>
          <Button variant={"outline"} onClick={() => setCount(count + 1)}>
            + Increment
          </Button>
        </div>
      </div>
    </div>
  );
}

The useUndoRedoState hook accepts two arguments:

• initialState: The initial state value.
• options (optional): An object containing configuration options:
  • maxStackSize: The maximum size of the undo and redo stacks (default: 10).
  • onUndo: A callback function to be called after an undo operation.
  • onRedo: A callback function to be called after a redo operation.

The hook returns an array with two elements:

• state: The current state value.
• setState: A function to set a new state value. This function automatically adds the previous state to the undo stack, enabling undo operations.

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests on the GitHub repository

License

This project is licensed under the MIT License.