mui-tiptap
Version:
A Material-UI (MUI) styled WYSIWYG rich text editor, using Tiptap
23 lines (22 loc) • 1.01 kB
JavaScript
import { keydownHandler } from "@tiptap/pm/keymap";
import { Plugin } from "@tiptap/pm/state";
/**
* Create a `keymap` prosemirror plugin for keyboard shortcut use in Tiptap.
*
* This is an alternative to the `prosemirror-keymap` `keymap` factory function
* (https://github.com/ProseMirror/prosemirror-keymap/blob/bcc8280e38900edeb6ed946e496ad7dbc0c17f95/src/keymap.js#L72-L74)
* and follows identical logic, but because (a) Tiptap will only unregister
* plugins properly if they have unique string names or `PluginKeys`
* (https://github.com/ueberdosis/tiptap/blob/5daa870b0906f0387fe07041681bc6f5b3774617/packages/core/src/Editor.ts#L217-L220),
* and (b) the original `keymap` function doesn't allow us to specify/define our
* own key, we have to use our own factory function that allows us to specify
* one.
*/
export default function keymapPluginFactory(bindings, key) {
return new Plugin({
key,
props: {
handleKeyDown: keydownHandler(bindings),
},
});
}