feat: add editor prop to KeyboardShortcutCommand

ueberdosis · Apr 20, 2021 · e0c2460 · e0c2460
1 parent d14942e
commit e0c2460
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 8 deletions.
diff --git a/packages/core/src/Extension.ts b/packages/core/src/Extension.ts
@@ -1,11 +1,15 @@
 import { Plugin, Transaction } from 'prosemirror-state'
-import { Command as ProseMirrorCommand } from 'prosemirror-commands'
 import { InputRule } from 'prosemirror-inputrules'
 import { Editor } from './Editor'
 import { Node } from './Node'
 import { Mark } from './Mark'
 import mergeDeep from './utilities/mergeDeep'
-import { GlobalAttributes, RawCommands, ParentConfig } from './types'
+import {
+  GlobalAttributes,
+  RawCommands,
+  ParentConfig,
+  KeyboardShortcutCommand,
+} from './types'
 import { ExtensionConfig } from '.'
 
 declare module '@tiptap/core' {
@@ -52,7 +56,7 @@ declare module '@tiptap/core' {
       editor: Editor,
       parent: ParentConfig<ExtensionConfig<Options>>['addKeyboardShortcuts'],
     }) => {
-      [key: string]: ProseMirrorCommand,
+      [key: string]: KeyboardShortcutCommand,
     },
 
     /**

diff --git a/packages/core/src/ExtensionManager.ts b/packages/core/src/ExtensionManager.ts
@@ -190,7 +190,15 @@ export default class ExtensionManager {
         )
 
         if (addKeyboardShortcuts) {
-          const keyMapPlugin = keymap(addKeyboardShortcuts())
+          const bindings = Object.fromEntries(
+            Object
+              .entries(addKeyboardShortcuts())
+              .map(([shortcut, method]) => {
+                return [shortcut, () => method({ editor: this.editor })]
+              }),
+          )
+
+          const keyMapPlugin = keymap(bindings)
 
           plugins.push(keyMapPlugin)
         }

diff --git a/packages/core/src/Mark.ts b/packages/core/src/Mark.ts
@@ -5,14 +5,14 @@ import {
   MarkType,
 } from 'prosemirror-model'
 import { Plugin, Transaction } from 'prosemirror-state'
-import { Command as ProseMirrorCommand } from 'prosemirror-commands'
 import { InputRule } from 'prosemirror-inputrules'
 import mergeDeep from './utilities/mergeDeep'
 import {
   Attributes,
   RawCommands,
   GlobalAttributes,
   ParentConfig,
+  KeyboardShortcutCommand,
 } from './types'
 import { Node } from './Node'
 import { MarkConfig } from '.'
@@ -64,7 +64,7 @@ declare module '@tiptap/core' {
       type: MarkType,
       parent: ParentConfig<MarkConfig<Options>>['addKeyboardShortcuts'],
     }) => {
-      [key: string]: ProseMirrorCommand,
+      [key: string]: KeyboardShortcutCommand,
     },
 
     /**

diff --git a/packages/core/src/Node.ts b/packages/core/src/Node.ts
@@ -4,7 +4,6 @@ import {
   Node as ProseMirrorNode,
   NodeType,
 } from 'prosemirror-model'
-import { Command as ProseMirrorCommand } from 'prosemirror-commands'
 import { Plugin, Transaction } from 'prosemirror-state'
 import { InputRule } from 'prosemirror-inputrules'
 import mergeDeep from './utilities/mergeDeep'
@@ -14,6 +13,7 @@ import {
   GlobalAttributes,
   RawCommands,
   ParentConfig,
+  KeyboardShortcutCommand,
 } from './types'
 import { NodeConfig } from '.'
 import { Editor } from './Editor'
@@ -64,7 +64,7 @@ declare module '@tiptap/core' {
       type: NodeType,
       parent: ParentConfig<NodeConfig<Options>>['addKeyboardShortcuts'],
     }) => {
-      [key: string]: ProseMirrorCommand,
+      [key: string]: KeyboardShortcutCommand,
     },
 
     /**

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -77,6 +77,8 @@ export type Command = (props: CommandProps) => boolean
 
 export type CommandSpec = (...args: any[]) => Command
 
+export type KeyboardShortcutCommand = (props: { editor: Editor }) => boolean
+
 export type Attribute = {
   default: any,
   rendered?: boolean,