prosekit/extensions/input-rule

MarkInputRuleOptions

attrs?: null | Attrs | ((match: RegExpMatchArray) => null | Attrs)

Attributes to set on the mark.

inCodeMark?: boolean

Whether this rule should fire inside marks marked as code.

Default: false

regex: RegExp

The regular expression to match against, which should end with $ and has exactly one capture group. All other matched text outside the capture group will be deleted.

type: string | MarkType

The type of mark to set.

defineInputRule

function defineInputRule(rule: InputRule): PlainExtension

Defines an input rule extension.

defineMarkInputRule

function defineMarkInputRule(options: MarkInputRuleOptions): PlainExtension

Defines an input rule for automatically adding inline marks when a given pattern is typed.

defineTextBlockInputRule

function defineTextBlockInputRule(options: { attrs?: null | Attrs | ((match: RegExpMatchArray) => null | Attrs); regex: RegExp; type: string | NodeType }): PlainExtension

Defines an input rule that changes the type of a textblock when the matched text is typed into it.

defineWrappingInputRule

function defineWrappingInputRule(options: { attrs?: null | Attrs | ((match: RegExpMatchArray) => null | Attrs); join?: (match: RegExpMatchArray, node: ProseMirrorNode) => boolean; regex: RegExp; type: string | NodeType }): PlainExtension

Defines an input rule for automatically wrapping a textblock when a given string is typed.