UndoRedo

Description

Initializes the plugin and registers all built-in undo/redo action handlers for the given Handsontable instance.

Options

undo

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.

Undo and redo

This option can only be set at the grid level. It has no effect when set in the columns, cells, or cell options.

Default: undefined
Example

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

Members

PLUGIN_KEY

Source code

UndoRedo.PLUGIN_KEY

Returns the plugin key used to identify this plugin in Handsontable settings.

PLUGIN_PRIORITY

Source code

UndoRedo.PLUGIN_PRIORITY

Returns the priority order used to determine the order in which plugins are initialized.

SETTING_KEYS

Source code

UndoRedo.SETTING_KEYS

Returns whether the plugin handles its own settings keys without a dedicated key list.

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
Example

1
// Register a custom action, for example when setting cell metadata directly
2
// (a change that UndoRedo doesn't track by default).
3
function setCellBackgroundColor(row, col, className) {
4
  const undoRedo = hot.getPlugin('undoRedo');
5
  const previousClassName = hot.getCellMeta(row, col).className;
6

7
  undoRedo.done(() => ({
8
    actionType: 'cellBackgroundColor',
9
    undo(instance, callback) {
10
      instance.setCellMeta(row, col, 'className', previousClassName);
11
      instance.render();
12
      callback();
13
    },
14
    redo(instance, callback) {
15
      instance.setCellMeta(row, col, 'className', className);
16
      instance.render();
17
      callback();
18
    },
19
  }), 'cellBackgroundColor');
20

21
  hot.setCellMeta(row, col, 'className', className);
22
  hot.render();
23
}

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.