@lexical/history
TypeScript icon, indicating that this package has built-in type declarations

0.15.0 • Public • Published

@lexical/history

See API Documentation

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.

function registerHistory(
  editor: LexicalEditor,
  externalHistoryState: HistoryState,
  delay: number,
): () => 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:

import {UNDO_COMMAND, REDO_COMMAND} from 'lexical';

<Toolbar>
  <Button onClick={() => editor.dispatchCommand(UNDO_COMMAND)}>Undo</Button>
  <Button onClick={() => editor.dispatchCommand(REDO_COMMAND)}>Redo</Button>
</Toolbar>;

Package Sidebar

Install

npm i @lexical/history

Weekly Downloads

281,964

Version

0.15.0

License

MIT

Unpacked Size

36.4 kB

Total Files

12

Last publish

Collaborators

  • ipavlov001
  • fantactuka
  • acywatson
  • zurfyx
  • trueadm