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 in 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

Note: If you have loaded EditorJS with any initial data (such as some saved content), you must pass in an initialData object. If you don't, the default initial undo state lead to an empty editor.

You may 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
editor	EditorJS	Required. The EditorJS instance.
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

Code of conduct

We welcome everyone to contribute. Make sure you have read the CODE_OF_CONDUCT before.

Contributing

For information on how to contribute, please refer to our CONTRIBUTING guide.

Changelog

Features and bug fixes are listed in the CHANGELOG file.

License

This library is licensed under an MIT license. See LICENSE for details.

Acknowledgements

Made with 💙 by kommitters Open Source

Changelog

0.2.0 (09.09.2021)

• Accept strings in the holder key.
• Updated packages with known security breaches.
• Docs updated.