Files
tiptap/docs/src/docPages/api/extensions/history.md
2020-09-24 17:27:26 +02:00

2.1 KiB

History

This extension provides history support. All changes to the document will be tracked and can be removed with undo. Undone changes can be applied with redo again.

Installation

# With npm
npm install @tiptap/extension-history

# Or: With Yarn
yarn add @tiptap/extension-history

Settings

Option Type Default Description
historyPluginOptions Object {} Supports the following configuration options:

depth: The amount of history events that are collected before the oldest events are discarded. Defaults to 100.

newGroupDelay: The delay between changes after which a new group should be started. Defaults to 500 (milliseconds). Note that when changes aren't adjacent, a new group is always started.

Commands

Command Options Description
undo Undo the last change.
redo Redo the last change.

Keyboard shortcuts

Undo

  • Windows & Linux: Control  Z
  • macOS: Command  Z

Redo

  • Windows & Linux: Shift  Control  Z
  • macOS: Shift  Command  Z

Source code

packages/extension-history/

Usage