ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #14 from ueberdosis/feature/flatten-history-options

Browse Source 
flatten history plugin options
This commit is contained in:
Philipp Kühn
2020-09-27 21:30:09 +02:00
committed by GitHub
parent 49b47c837b 54bbd8a861
commit e67c041c31
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/src/docPages/api/extensions/history.md
View File

@@ -12,8 +12,9 @@ yarn add @tiptap/extension-history
## Settings ## Settings
| Option | Type | Default | Description | | 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. | | 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 ## Commands
| Command | Options | Description | | Command | Options | Description |

8
packages/extension-history/index.ts
View File

@@ -13,13 +13,15 @@ declare module '@tiptap/core/src/Editor' {
} }
export interface HistoryOptions { export interface HistoryOptions {
historyPluginOptions: Record<string, unknown>, depth: number,
newGroupDelay: number,
} }
export default new Extension<HistoryOptions>() export default new Extension<HistoryOptions>()
.name('history') .name('history')
.defaults({ .defaults({
historyPluginOptions: {}, depth: 100,
newGroupDelay: 500,
}) })
.commands(() => ({ .commands(() => ({
undo: () => ({ state, dispatch }) => { undo: () => ({ state, dispatch }) => {
@@ -35,6 +37,6 @@ export default new Extension<HistoryOptions>()
'Shift-Mod-z': () => editor.redo(), 'Shift-Mod-z': () => editor.redo(),
})) }))
.plugins(({ options }) => [ .plugins(({ options }) => [
history(options.historyPluginOptions), history(options),
]) ])
.create() .create()