tiptap/docs/api/extensions/history.md

description	icon
If I could just go back and make everything undone … you can.	history-line

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

npm install @tiptap/extension-history

:::warning Are you using Yarn, pNPM, npm 6 or less? Unfortunately your package manager does not install peer dependencies automatically and you have to install them by your own. Please see here which packages are needed and how to install them. :::

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/

Usage

https://embed.tiptap.dev/preview/Extensions/History