editorjs-undo

EditorJS Undo Plugin

Undo/Redo feature for Editor.js.

Installation

Install via NPM

Get the package

$ npm i --save-dev editorjs-undo

Include module at your application

import Undo from 'editorjs-undo';

Usage

const editor = new EditorJS({
  onReady: () => {
    new Undo({ editor });
  },
});

On the editor, use Ctrl + Z or ⌘ + Z to undo, or use Ctrl + Y or ⌘ + Y to redo.

Initialize the plugin with data

To initialize the plugin with data, use the initialize method inside the editor's onReady callback.

const editor = new EditorJS({
  onReady: () => {
    const undo = new Undo({ editor });
    undo.initialize(initialData);
  },
});

Available Options

Field	Type	Description
maxLength	Number	Max amount of changes recorded by the history stack.
onUpdate()	function	Callback called when the user performs an undo or redo action.

Development

Development mode

$ yarn build:dev

Production release

1. Create a production bundle

$ yarn build

1. Commit dist/bundle.js

Run tests

$ yarn test

Contributing and Development

Bug reports and pull requests are welcome on GitHub https://github.com/kommitters/editorjs-undo. Everyone is welcome to participate in the project. If you are thinking about contributing to the project, please check our Contributing Guide.

Changelog

See the CHANGELOG for versions details.

License

See LICENSE for details.

Credits

Made with 💙 by kommit

Changelog

0.1.7 (16.06.2021)

• Set the undo/redo event listeners in the holder element instead of the whole document.