Interface WidgetRule

interface WidgetRule {
    rule: RegExp;
    toDOM: (text: string, context: WidgetContext) => HTMLElement;
    toSource?: (text: string) => WidgetSourcePart[];
}

Properties

rule: RegExp

the markdown text the widget stands for; matched outside code spans and code blocks

toDOM: (text: string, context: WidgetContext) => HTMLElement

the widget's DOM in the WYSIWYG editor, the preview, the viewer and getHTML()

toSource?: (text: string) => WidgetSourcePart[]

styles the widget's text in the markdown editor, where it stays editable markdown