Class ProseMirrorHighlightMatchesPlugin

A ProseMirrorPlugin wrapper around the PossibleMatchesTooltip class.

Hierarchy (View Summary)

ProseMirrorPlugin
- ProseMirrorHighlightMatchesPlugin

Index

Constructors

Accessors

Methods

Constructors

constructor

new ProseMirrorHighlightMatchesPlugin(
schema: Schema,
options?: any,
): ProseMirrorHighlightMatchesPlugin
Parameters
- schema: Schema
  The ProseMirror schema.
- Optionaloptions: any = {}
  Additional options to configure the plugin's behaviour.
Returns ProseMirrorHighlightMatchesPlugin
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

`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