Class ProseMirrorKeyMaps

A class responsible for building the keyboard commands for the ProseMirror editor.

Hierarchy (View Summary)

ProseMirrorPlugin
- ProseMirrorKeyMaps

Index

Constructors

Accessors

Methods

buildMapping build

Constructors

constructor

new ProseMirrorKeyMaps(
schema: Schema,
options?: { joinDoubleBreak?: boolean; onSave?: Function },
): ProseMirrorKeyMaps
Parameters
- schema: Schema
  The ProseMirror schema to build keymaps for.
- Optionaloptions: { joinDoubleBreak?: boolean; onSave?: Function } = {}
  Additional options to configure the plugin's behavior.
  - OptionaljoinDoubleBreak?: boolean
    If a double line-break is detected, join it into a paragraph instead.
  - OptionalonSave?: Function
    A function to call when Ctrl+S is pressed.
Returns ProseMirrorKeyMaps
Overrides ProseMirrorPlugin.constructor

Accessors

`Static`key

get key(): PluginKey<any>
A unique key for this plugin that can be used to identify a plugin instance in any given editor.

Returns PluginKey<any>
Inherited from ProseMirrorPlugin.key

Methods

buildMapping

buildMapping(): Record<string, ProseMirrorCommand>
Build keyboard commands for nodes and marks present in the schema.

Returns Record<string, ProseMirrorCommand>
An object of keyboard shortcuts to editor functions.

`Static`build

build(schema: any, options?: {}): Plugin<any>
Build the plugin.
Parameters
- schema: any
  The ProseMirror schema to build the plugin against.
- options: {} = {}
  Additional options to pass to the plugin.
Returns Plugin<any>
Overrides ProseMirrorPlugin.build