npm install undooUndoo
Undo/redo manager
Installation
$3
``
npm install undoo --save
`
$3
#### Local
`html
`
#### CDN unpkg
`html
`
Example
`javascript
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
`javascript
const Undoo = require('undoo');
const myHistory = new Undoo({
provider: () => document.getElementById('myTextArea').value
});
myHistory.save();
`
API
Undoo
Kind: global class * Undoo
* [new Undoo([opts])](#new_Undoo_new)
* _instance_
* .canUndo() ⇒ boolean
* .canRedo() ⇒ boolean
* .import(history) ⇒ Undoo
* .history() ⇒ Array
* [.save([item])](#Undoo+save) ⇒ Undoo
* [.suspendSave([state])](#Undoo+suspendSave) ⇒ Undoo
* .allowedSave() ⇒ boolean
* .clear() ⇒ Undoo
* [.undo([callback])](#Undoo+undo) ⇒ Undoo
* [.redo([callback])](#Undoo+redo) ⇒ Undoo
.current() ⇒ \
* .count() ⇒
number.initialState() ⇒
\* .onUpdate(callback) ⇒
Undoo* .onMaxLength(callback) ⇒
Undoo* .onBeforeSave(callback) ⇒
Undoo* _inner_
* ~undoCallback :
function* ~redoCallback :
function* ~updateCallback :
function* ~maxLengthCallback :
function* ~beforeSaveCallback :
function$3
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 |
$3
Check if undo is available
Kind: instance method of Undoo
$3
Kind: instance method of
Undoo Check: if redo is available
$3
Import external history
Kind: instance method of Undoo
| Param | Type |
|---|---|
| history | Array |
$3
Get history
Kind: instance method of Undoo
$3
Save history
Kind: instance method of Undoo
| Param | Type |
|---|---|
| [item] | * |
$3
Suspend save method
Kind: instance method of Undoo
| Param | Type | Default |
|---|---|---|
| [state] | boolean | true |
$3
Check if save is allowed
Kind: instance method of Undoo
$3
Clear history
Kind: instance method of Undoo
$3
Undo
Kind: instance method of Undoo
| Param | Type | Description |
|---|---|---|
| [callback] | undoCallback | callback function |
$3
Redo
Kind: instance method of Undoo
| Param | Type | Description |
|---|---|---|
| [callback] | redoCallback | callback function |
$3
Get current item in history
Kind: instance method of Undoo
$3
Count history items, the first element is not considered
Kind: instance method of Undoo
$3
Get initial state history
Kind: instance method of Undoo
$3
Triggered when history is updated
Kind: instance method of Undoo
| Param | Type | Description |
|---|---|---|
| callback | updateCallback | callback function |
$3
Triggered when maxLength is exceeded
Kind: instance method of Undoo
| Param | Type | Description |
|---|---|---|
| callback | maxLengthCallback | callback function |
$3
Triggered before save
Kind: instance method of Undoo
| Param | Type | Description |
|---|---|---|
| callback | beforeSaveCallback | callback function |
Example
`jsfalse
// If callback returns the save command will not be executed
myHistory.onBeforeSave(()=>false)
// You can overwrite item before save
myHistory.onBeforeSave((item)=>{
return item.toUpperCase();
})``
$3
undo callback
Kind: inner typedef of Undoo
| Param | Type | Description |
|---|---|---|
| item | * | current history item |
$3
redo callback
Kind: inner typedef of Undoo
| Param | Type | Description |
|---|---|---|
| item | * | current history item |
$3
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 |
| history | Array | history array |
| istance | Undoo |
$3
onMaxLength callback
Kind: inner typedef of Undoo
| Param | Type | Description |
|---|---|---|
| item | * | current history item |
| history | Array | history array |
| istance | Undoo |
$3
onBeforeSave callback
Kind: inner typedef of Undoo
| Param | Type | Description |
|---|---|---|
| item | * | current history item |
| istance | Undoo |
Changelog
You can view the changelog here
License
Undoo is open-sourced software licensed under the MIT license
Author
Fabio Ricali