48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
# History
|
||
[](https://www.npmjs.com/package/@tiptap/extension-history)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-history?minimal=true)
|
||
|
||
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
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-history
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-history
|
||
```
|
||
|
||
## Settings
|
||
| Option | Type | Default | Description |
|
||
| ------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| depth | `Number` | `100` | The amount of history events that are collected before the oldest events are discarded. Defaults to 100. |
|
||
| newGroupDelay | `Number` | `500` | 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. |
|
||
|
||
## Commands
|
||
|
||
### undo()
|
||
Undo the last change.
|
||
|
||
```js
|
||
editor.commands.undo()
|
||
```
|
||
### redo()
|
||
Redo the last change.
|
||
|
||
```js
|
||
editor.commands.redo()
|
||
```
|
||
|
||
## Keyboard shortcuts
|
||
| Command | Windows/Linux | macOS |
|
||
| ------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||
| undo() | `Control` `Z`<br>`Control` `я` | `Cmd` `Z`<br>`Cmd` `я` |
|
||
| redo() | `Shift` `Control` `Z`<br>`Control` `Y`<br>`Shift` `Control` `я` | `Shift` `Cmd` `Z`<br>`Cmd` `Y`<br>`Shift` `Cmd` `я` |
|
||
|
||
## Source code
|
||
[packages/extension-history/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Extensions/History"></tiptap-demo>
|