tiptap/docs/src/docPages/api/extensions/history.md

37 lines
2.1 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# 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
```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
| Option | Type | Default | Description |
| -------------------- | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| historyPluginOptions | Object | {} | Supports the following configuration options:<br /><br />**depth:** The amount of history events that are collected before the oldest events are discarded. Defaults to 100.<br /><br />**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. |
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
## Keyboard shortcuts
2020-09-23 18:03:03 +08:00
### Undo
* Windows & Linux: `Control` + `Z`
* macOS: `Command` + `Z`
2020-08-19 03:39:41 +08:00
### Redo
* Windows & Linux: `Shift` + `Control` + `Z`
* macOS: `Shift` + `Command` + `Z`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
[packages/extension-history/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-history/)
2020-08-19 03:39:41 +08:00
## Usage
<demo name="Extensions/History" highlight="3-8,20,39" />