Class ProseMirrorPlugin`Abstract`

Hierarchy (View Summary)

ProseMirrorPlugin

Index

Constructors

Accessors

Methods

Constructors

constructor

new ProseMirrorPlugin(schema: Schema): ProseMirrorPlugin
An abstract class for building a ProseMirror Plugin.
Parameters
- schema: Schema
  The schema to build the plugin against.
Returns ProseMirrorPlugin
See

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>

Methods

`Static` `Abstract`build

build(schema: Schema, options?: object): Plugin
Build the plugin.
Parameters
- schema: Schema
  The ProseMirror schema to build the plugin against.
- Optionaloptions: object = {}
  Additional options to pass to the plugin.
Returns Plugin