2020-08-19 03:39:41 +08:00
# History
2020-09-02 21:48:02 +08:00
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.
2020-09-23 15:52:04 +08:00
## Installation
```bash
# With npm
npm install @tiptap/extension -history
# Or: With Yarn
yarn add @tiptap/extension -history
```
2020-09-23 18:03:03 +08:00
## Settings
2020-09-27 16:52:09 +08:00
| 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’
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
2020-09-10 16:21:24 +08:00
| Command | Options | Description |
| ------- | ------- | --------------------- |
| undo | — | Undo the last change. |
| redo | — | Redo the last change. |
2020-08-19 03:39:41 +08:00
2020-09-10 17:24:33 +08:00
## Keyboard shortcuts
2020-09-23 18:03:03 +08:00
### Undo
2020-09-24 23:33:04 +08:00
* Windows/Linux: `Control` `Z`
* macOS: `Cmd` `Z`
2020-08-19 03:39:41 +08:00
2020-09-02 21:48:02 +08:00
### Redo
2020-09-24 23:33:04 +08:00
* Windows/Linux: `Shift` `Control` `Z`
* macOS: `Shift` `Cmd` `Z`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2020-09-02 21:48:02 +08:00
[packages/extension-history/ ](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/ )
2020-08-19 03:39:41 +08:00
2020-09-02 21:48:02 +08:00
## Usage
2020-09-24 23:27:26 +08:00
< demo name = "Extensions/History" highlight = "3-8,20,39" / >
