UndoRedo

Plugin: UndoRedo

Description

Handsontable UndoRedo plugin allows to undo and redo certain actions done in the table.

Note, that not all actions are currently undo-able. The UndoRedo plugin is enabled by default.

Example

undo: true

Options

undo

Source code

undoRedo.undo : boolean

The undo option configures the UndoRedo plugin.

You can set the undo option to one of the following:

Setting	Description
true	Enable the UndoRedo plugin
false	Disable the UndoRedo plugin

By default, the undo option is set to true, To disable the UndoRedo plugin completely, set the undo option to false.

Read more:

• Undo and redo

Default: undefined
Example

// enable the `UndoRedo` plugin
undo: true,

Methods

clear

Source code

undoRedo.clear()

Clears undo and redo history.

destroy

Source code

undoRedo.destroy()

Destroys the plugin instance.

disablePlugin

Source code

undoRedo.disablePlugin()

Disables the plugin functionality for this Handsontable instance.

done

Source code

undoRedo.done(wrappedAction, [source])

Stash information about performed actions.

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange

Param	Type	Description
wrappedAction	function	The action descriptor wrapped in a closure.
[source]	string	optional Source of the action. It is defined just for more general actions (not related to plugins).

enablePlugin

Source code

undoRedo.enablePlugin()

Enables the plugin functionality for this Handsontable instance.

isEnabled

Source code

undoRedo.isEnabled() ⇒ boolean

Checks if the plugin is enabled in the handsontable settings. This method is executed in Hooks#beforeInit hook and if it returns true then the UndoRedo#enablePlugin method is called.

isRedoAvailable

Source code

undoRedo.isRedoAvailable() ⇒ boolean

Checks if redo action is available.

Returns: boolean - Return true if redo can be performed, false otherwise.

isUndoAvailable

Source code

undoRedo.isUndoAvailable() ⇒ boolean

Checks if undo action is available.

Returns: boolean - Return true if undo can be performed, false otherwise.

redo

Source code

undoRedo.redo()

Redo the previous action performed to the table (used to reverse an undo).

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange, Hooks#event:beforeRedo, Hooks#event:afterRedo

undo

Source code

undoRedo.undo()

Undo the last action performed to the table.

Emits: Hooks#event:beforeUndoStackChange, Hooks#event:afterUndoStackChange, Hooks#event:beforeRedoStackChange, Hooks#event:afterRedoStackChange, Hooks#event:beforeUndo, Hooks#event:afterUndo