tiptap/docs/api/extensions/history.md

# History
[![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
# 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`&nbsp;`Z`<br>`Control`&nbsp;`я`                                                 | `Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`я`                                             |
| redo()  | `Shift`&nbsp;`Control`&nbsp;`Z`<br>`Control`&nbsp;`Y`<br>`Shift`&nbsp;`Control`&nbsp;`я` | `Shift`&nbsp;`Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`Y`<br>`Shift`&nbsp;`Cmd`&nbsp;`я` |

## Source code
[packages/extension-history/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/)

## Usage
<tiptap-demo name="Extensions/History"></tiptap-demo>
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
+								# History
-												docs: add badges to all extensions

											
										
										
											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)
-												update the history extension page, add a demo with tests

											
										
										
											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.
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								## Installation
 								```bash
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with npm
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								npm install @tiptap/extension-history
-												update content

											
										
										
											2020-10-30 21:24:16 +08:00
+								# with Yarn
-												add installation instructions to all extensions

											
										
										
											2020-09-23 15:52:04 +08:00
+								yarn add @tiptap/extension-history
 								```
-												a ton of improvements

											
										
										
											2020-09-23 18:03:03 +08:00
+								## Settings
-												docs: add HTMLAttributes

											
										
										
											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 aren’t adjacent, a new group is always started. |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												improve the extensions documentation

											
										
										
											2020-08-20 21:33:16 +08:00
+								## Commands
-												docs: make all extension keyboard shortcuts a table

											
										
										
											2021-10-02 05:13:49 +08:00
 								### undo()
 								Undo the last change.
 								```js
 								editor.commands.undo()
 								```
 								### redo()
 								Redo the last change.
 								```js
 								editor.commands.redo()
 								```
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												rename keybindings to keyboard shortcuts

											
										
										
											2020-09-10 17:24:33 +08:00
+								## Keyboard shortcuts
-												docs: make all extension keyboard shortcuts a table

											
										
										
											2021-10-02 05:13:49 +08:00
+								| Command | Windows/Linux                                                                            | macOS                                                                        |
 								| ------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
 								| undo()  | `Control`&nbsp;`Z`<br>`Control`&nbsp;`я`                                                 | `Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`я`                                             |
 								| redo()  | `Shift`&nbsp;`Control`&nbsp;`Z`<br>`Control`&nbsp;`Y`<br>`Shift`&nbsp;`Control`&nbsp;`я` | `Shift`&nbsp;`Cmd`&nbsp;`Z`<br>`Cmd`&nbsp;`Y`<br>`Shift`&nbsp;`Cmd`&nbsp;`я` |
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												minor improvements

											
										
										
											2020-09-21 22:59:28 +08:00
+								## Source code
-												replace link to GitHub repository

											
										
										
											2021-04-21 21:31:11 +08:00
+								[packages/extension-history/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-history/)
-												move all extensions to separate pages

											
										
										
											2020-08-19 03:39:41 +08:00
-												update the history extension page, add a demo with tests

											
										
										
											2020-09-02 21:48:02 +08:00
+								## Usage
-												replace demo component with custom element

											
										
										
											2021-08-26 05:10:20 +08:00
+								<tiptap-demo name="Extensions/History"></tiptap-demo>