mirror of https://github.com/ueberdosis/tiptap.git synced 2024-12-13 09:29:01 +08:00

Hans Pagel 0edc57245c docs: add descriptions to all extensions

2021-10-14 00:13:50 +02:00

2.2 KiB

Raw Blame History

description
If I could just go back and make everything undone … you can.

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

# with Yarn
yarn add @tiptap/extension-history

Settings

depth

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

Default: 100

History.configure({
  depth: 10,
})

newGroupDelay

The delay between changes after which a new group should be started (in milliseconds). When changes aren’t adjacent, a new group is always started.

Default: 500

History.configure({
  newGroupDelay: 1000,
})

Commands

undo()

Undo the last change.

editor.commands.undo()

redo()

Redo the last change.

editor.commands.redo()

Keyboard shortcuts

Command	Windows/Linux	macOS
undo()	`Control` `Z` `Control` `я`	`Cmd` `Z` `Cmd` `я`
redo()	`Shift` `Control` `Z` `Control` `Y` `Shift` `Control` `я`	`Shift` `Cmd` `Z` `Cmd` `Y` `Shift` `Cmd` `я`

Source code

packages/extension-history/

2.2 KiB Raw Blame History Unescape Escape