tiptap/docs/api/extensions/history.md

48 lines
2.1 KiB
Markdown
Raw Normal View History

2020-08-19 03:39:41 +08:00
# History
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-history.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-history)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-history.svg)](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
2020-10-30 21:24:16 +08:00
# with npm
npm install @tiptap/extension-history
2020-10-30 21:24:16 +08:00
# with Yarn
yarn add @tiptap/extension-history
```
2020-09-23 18:03:03 +08:00
## Settings
2020-11-18 19:12:34 +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 arent adjacent, a new group is always started. |
2020-08-19 03:39:41 +08:00
2020-08-20 21:33:16 +08:00
## Commands
| Command | Parameters | Description |
2020-11-06 22:44:23 +08:00
| ------- | ---------- | --------------------- |
| 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: `Cmd` `Z`
#### Russian keyboard layouts
* Windows/Linux: `Control` `я`
* macOS: `Cmd` `я`
2020-08-19 03:39:41 +08:00
### Redo
2020-12-04 00:23:54 +08:00
* Windows/Linux: `Shift` `Control` `Z` or `Control` `Y`
* macOS: `Shift` `Cmd` `Z` or `Cmd` `Y`
#### Russian keyboard layouts
* Windows/Linux: `Shift` `Control` `я`
* macOS: `Shift` `Cmd` `я`
2020-08-19 03:39:41 +08:00
2020-09-21 22:59:28 +08:00
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-history/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/)
2020-08-19 03:39:41 +08:00
## Usage
<tiptap-demo name="Extensions/History"></tiptap-demo>