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

flatten history plugin options

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

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

packages/extension-history/index.ts

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