Have ideas to improve npm?Join in the discussion! »

react-final-form-undo

1.0.1 • Public • Published

react-final-form-undo

Simple Undo/redo component and hook for react-final-form

Demo

https://nosovsh.github.io/react-final-form-undo/

Getting Started

Prerequisites

npm install react react-dom react-final-form final-form

Installing

npm install react-final-form-undo

Usage with component

import {Undo} from "react-final-form-undo";
 
// Then inside your form
<Undo>
  {({canUndo, canRedo, undo, redo}) => (
    <>
      <button
        onClick={undo}
        disabled={!canUndo}
      >
        Undo
      </button>
      
      <button
        onClick={redo}
        disabled={!canRedo}
      >
        Redo
      </button>
    </>
  )}
</Undo>

Usage with hook

import {useUndo} from "react-final-form-undo";
 
// Then inside your form
const {canUndo, canRedo, undo, redo} = useUndo();
 
// Then inside render
<>
  <button
    onClick={undo}
    disabled={!canUndo}
  >
    Undo
  </button>
 
  <button
    onClick={redo}
    disabled={!canRedo}
  >
    Redo
  </button>
</>

Important

  • initialValues for react-final-form should be provided and should be not undefined
  • Undo stack is cleared when initial values are changed. So if you want your undo stack to be cleared after form save - set initial values to a new values. See example.

TODO:

  • implement tests
  • fix known bug that undo stack is not cleared when you roll back to the beginning and then submit form
  • clear undo stack after reset and initialize methods call

Install

npm i react-final-form-undo

DownloadsWeekly Downloads

6

Version

1.0.1

License

MIT

Unpacked Size

10.2 kB

Total Files

7

Last publish

Collaborators

  • avatar