Class ProseMirrorInputRules

A class responsible for building the input rules for the ProseMirror editor.

Hierarchy (View Summary)

ProseMirrorPlugin
- ProseMirrorInputRules

Index

Constructors

Accessors

Methods

buildRules build

Constructors

constructor

new ProseMirrorInputRules(schema: Schema): ProseMirrorInputRules
An abstract class for building a ProseMirror Plugin.
Parameters
- schema: Schema
  The schema to build the plugin against.
Returns ProseMirrorInputRules
See
Inherited from 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

buildRules

buildRules(): InputRule[]
Build input rules for node types present in the schema.

Returns InputRule[]

`Static`build

build(
schema: Schema,
options?: { minHeadingLevel?: number },
): Plugin<PluginState>
Build the plugin.
Parameters
- schema: Schema
  The ProseMirror schema to build the plugin against.
- Optionaloptions: { minHeadingLevel?: number } = {}
  Additional options to pass to the plugin.
  - OptionalminHeadingLevel?: number
    The minimum heading level to start from when generating heading input rules. The resulting heading level for a heading rule is equal to the number of leading hashes minus this number.
Returns Plugin<PluginState>
Overrides ProseMirrorPlugin.build