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

Hierarchy (View Summary)

Constructors

Methods

Constructors

Methods

  • Build input rules for node types present in the schema.

    Returns InputRule[]

  • 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>