# ♻️ use-undo undo/redo functionality with React [Hooks](https://reactjs.org/docs/hooks-intro.html).

screensho

## Installation ```sh yarn add use-undo ``` ## Usage [![Edit use-undo-demo](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/use-undo-demo-hifeo?fontsize=14&hidenavigation=1&theme=dark&view=editor) ```js import React from 'react'; import ReactDOM from 'react-dom'; import useUndo from 'use-undo'; const App = () => { const [ countState, { set: setCount, reset: resetCount, undo: undoCount, redo: redoCount, canUndo, canRedo, }, ] = useUndo(0); const { present: presentCount } = countState; return (

You clicked {presentCount} times

); }; ``` ## Manual Checkpoints Manual checkpoints are helpful also when you want manual control over checkpoints. For example it is more helpful when you want to handle input type html tag where value needs to be handled alongside the undo and redo functionality should be handled over some conditions. ```js import React from 'react'; import ReactDOM from 'react-dom'; import useUndo from 'use-undo'; const App = () => { const [ countState, { set: setCount, reset: resetCount, undo: undoCount, redo: redoCount, canUndo, canRedo, }, ] = useUndo(0, { useCheckpoints: true }); const { present: presentCount } = countState; return (

You clicked {presentCount} times

); }; ``` ## API ### useUndo ```js const [state, actions] = useUndo(initialState); ``` #### state ##### Type: `Object` | Key | Type | Description | | ------- | :-----: | ------------------ | | past | `Array` | The undo stack. | | present | `Any` | The present state. | | future | `Array` | The redo stack. | #### actions ##### Type: `Object` | Key | Type | Description | | ------- | :--------: | ------------------------------------------------------------------------------------------ | | set | `function` | Assign a new value to `present`. | | reset | `function` | Clear `past` array and `future` array. Assign a new value to `present`. | | undo | `function` | See [handling-undo](https://redux.js.org/recipes/implementing-undo-history#handling-undo). | | redo | `function` | See [handling-redo](https://redux.js.org/recipes/implementing-undo-history#handling-redo). | | canUndo | `boolean` | Check whether `state.undo.length` is `0`. | | canRedo | `boolean` | Check whether `state.redo.length` is `0`. | ## How does it work? Refer to [_Redux Implementing Undo History_](hhttps://redux.js.org/recipes/implementing-undo-history), `use-undo` implements the same concect with [`useReducer`](https://reactjs.org/docs/hooks-reference.html#usereducer). The state structure looks like: ```js { past: Array, present: , future: Array } ``` It stores all states we need. To operate on this state, there are three functions in [`actions`](#actions) (`set`, `undo` and `redo`) that dispatch defined types and necessary value. ## Related repo - [omnidan/redux-undo](https://github.com/omnidan/redux-undo) ## License MIT © [homerchen19](https://github.com/homerchen19)

	Stars	Issues	Version	Updated	Created
redux-undo	2,897	35	1.1.0	10 months ago	9 years ago
undo			0.1.4	9 years ago	10 years ago
undo-peasy	16	0	0.6.3	2 years ago	4 years ago
undo-redo	1	0	0.1.5	8 years ago	8 years ago
use-undo	390	18	1.1.1	a year ago	5 years ago

redux-undo vs undo vs undo-peasy vs undo-redo vs use-undo

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past