@lexical/history

This package contains history helpers for Lexical.

Methods

registerHistory

Registers necessary listeners to manage undo/redo history stack and related editor commands. It returns unregister callback that cleans up all listeners and should be called on editor unmount.

1function registerHistory(
2  editor: LexicalEditor,
3  externalHistoryState: HistoryState,
4  delay: number,
5): () => void

Commands

History package handles UNDO_COMMAND, REDO_COMMAND and CLEAR_HISTORY_COMMAND commands. It also triggers CAN_UNDO_COMMAND and CAN_REDO_COMMAND commands when history state is changed. These commands could be used to work with history state:

1import {UNDO_COMMAND, REDO_COMMAND} from 'lexical';
2
3<Toolbar>
4  <Button onClick={() => editor.dispatchCommand(UNDO_COMMAND)}>Undo</Button>
5  <Button onClick={() => editor.dispatchCommand(REDO_COMMAND)}>Redo</Button>
6</Toolbar>;