undoo

Undoo

Undo/redo manager

Installation

Node.js

npm install undoo --save

Browser

Local

<script src="node_modules/undoo/dist/undoo.min.js"></script>

CDN unpkg

<script src="https://unpkg.com/undoo/dist/undoo.min.js"></script>

Example

const Undoo = require('undoo');

const myHistory = new Undoo();

myHistory
    .save('one');
    .save('two');
    .save('three');
    .save('four');

myHistory.undo((item)=>{
    console.log(item); //=> three
});

myHistory.current(); //=> three

myHistory.redo((item)=>{
    console.log(item); //=> four
});

Use provider

const Undoo = require('undoo');

const myHistory = new Undoo({
    provider: () => document.getElementById('myTextArea').value
});

myHistory.save();

API

Undoo

Kind: global class

• Undoo
  • new Undoo([opts])
  • instance
    • .save([item]) ⇒ Undoo
    • .clear() ⇒ Undoo
    • .undo(callback) ⇒ Undoo
    • .redo(callback) ⇒ Undoo
    • .current() ⇒ *
    • .count() ⇒ number
    • .onUpdate(callback) ⇒ Undoo
  • inner
    • ~undoCallback : function
    • ~redoCallback : function
    • ~updateCallback : function

new Undoo([opts])

Create instance

Param	Type	Default	Description
[opts]	Object		configuration object
[opts.provider]	function		optional function called on save that returns new state for history
[opts.maxLength]	number	20	max length history

undoo.save([item]) ⇒ Undoo

Save history

Kind: instance method of Undoo

Param	Type
[item]	*

undoo.clear() ⇒ Undoo

Clear history

Kind: instance method of Undoo

undoo.undo(callback) ⇒ Undoo

Undo

Kind: instance method of Undoo

Param	Type	Description
callback	undoCallback	callback function

undoo.redo(callback) ⇒ Undoo

Redo

Kind: instance method of Undoo

Param	Type	Description
callback	redoCallback	callback function

undoo.current() ⇒ *

Get current item in history

Kind: instance method of Undoo

undoo.count() ⇒ number

Count history items

Kind: instance method of Undoo

undoo.onUpdate(callback) ⇒ Undoo

Triggered when history is updated

Kind: instance method of Undoo

Param	Type	Description
callback	updateCallback	callback function

Undoo~undoCallback : function

undo callback

Kind: inner typedef of Undoo

Param	Type	Description
item	*	current history item

Undoo~redoCallback : function

redo callback

Kind: inner typedef of Undoo

Param	Type	Description
item	*	current history item

Undoo~updateCallback : function

onUpdate callback

Kind: inner typedef of Undoo

Param	Type	Description
item	*	current history item
action	string	action that has called update event. Can be: redo, undo, save, clear

Changelog

You can view the changelog here

License

Undoo is open-sourced software licensed under the MIT license

Author

Fabio Ricali