@liquid-js/underflow
    Preparing search index...

    Interface EditorOptions

    interface EditorOptions {
        el: HTMLElement;
        height?: string;
        minHeight?: string;
        initialValue?: string;
        previewStyle?: PreviewStyle;
        initialEditType?: EditorType;
        events?: EventMap;
        hooks?: HookMap;
        language?: string;
        useCommandShortcut?: boolean;
        toolbarItems?: (string | ToolbarItemOptions)[][];
        hideModeSwitch?: boolean;
        plugins?: EditorPlugin[];
        extendedAutolinks?: ExtendedAutolinks;
        placeholder?: string;
        linkAttributes?: Partial<Record<LinkAttributeNames, string>>;
        customHTMLRenderer?: Partial<
            Record<string, HTMLConvertor | HTMLMdNodeConvertorMap>,
        >;
        customMarkdownRenderer?: Partial<
            Record<
                | "document"
                | "list"
                | "blockQuote"
                | "item"
                | "heading"
                | "thematicBreak"
                | "paragraph"
                | "codeBlock"
                | "htmlBlock"
                | "table"
                | "tableHead"
                | "tableBody"
                | "tableRow"
                | "tableCell"
                | "tableDelimRow"
                | "tableDelimCell"
                | "refDef"
                | "customBlock"
                | "frontMatter"
                | "code"
                | "text"
                | "emph"
                | "strong"
                | "strike"
                | "link"
                | "image"
                | "htmlInline"
                | "linebreak"
                | "softbreak"
                | "customInline"
                | "html"
                | "widget"
                | "hardBreak"
                | "bulletList"
                | "orderedList"
                | "listItem"
                | "tableHeadCell"
                | "tableBodyCell"
                | "lineBreak"
                | "htmlSource"
                | "htmlInlineSource",
                ToMdConvertor,
            >,
        >;
        referenceDefinition?: boolean;
        customHTMLSanitizer?: Sanitizer;
        previewHighlight?: boolean;
        cursorLineHighlight?: boolean;
        frontMatter?: boolean;
        widgetRules?: WidgetRule[];
        theme?: string;
        autofocus?: boolean;
        viewer?: boolean;
        stripPastedStyles?: boolean;
        editPanel?: EditPanelOptions;
        toolbarStyle?: ToolbarStyle;
    }
    Index
    el height? minHeight? initialValue? previewStyle? initialEditType? events? hooks? language? useCommandShortcut? toolbarItems? hideModeSwitch? plugins? extendedAutolinks? placeholder? linkAttributes? customHTMLRenderer? customMarkdownRenderer? referenceDefinition? customHTMLSanitizer? previewHighlight? cursorLineHighlight? frontMatter? widgetRules? theme? autofocus? viewer? stripPastedStyles? editPanel? toolbarStyle?
    el: HTMLElement
    height?: string

    CSS height, toolbar included, e.g. 300px, 100% or auto; 300px by default

    minHeight?: string

    200px by default

    initialValue?: string
    previewStyle?: PreviewStyle

    the markdown preview in a tab or next to the editor; tab by default

    initialEditType?: EditorType

    markdown by default

    events?: EventMap
    hooks?: HookMap
    language?: string

    the UI language, whose locale must be imported first; en-US by default

    useCommandShortcut?: boolean

    true by default

    toolbarItems?: (string | ToolbarItemOptions)[][]

    groups of toolbar items, see docs/toolbar.md

    hideModeSwitch?: boolean

    hides the Markdown/WYSIWYG tabs

    plugins?: EditorPlugin[]

    plugins, or [plugin, options] pairs

    extendedAutolinks?: ExtendedAutolinks

    links URLs written without <>, as GFM does, or with a custom parser

    placeholder?: string
    linkAttributes?: Partial<Record<LinkAttributeNames, string>>

    added to the links rendered from markdown

    customHTMLRenderer?: Partial<
        Record<string, HTMLConvertor | HTMLMdNodeConvertorMap>,
    >
    customMarkdownRenderer?: Partial<
        Record<
            | "document"
            | "list"
            | "blockQuote"
            | "item"
            | "heading"
            | "thematicBreak"
            | "paragraph"
            | "codeBlock"
            | "htmlBlock"
            | "table"
            | "tableHead"
            | "tableBody"
            | "tableRow"
            | "tableCell"
            | "tableDelimRow"
            | "tableDelimCell"
            | "refDef"
            | "customBlock"
            | "frontMatter"
            | "code"
            | "text"
            | "emph"
            | "strong"
            | "strike"
            | "link"
            | "image"
            | "htmlInline"
            | "linebreak"
            | "softbreak"
            | "customInline"
            | "html"
            | "widget"
            | "hardBreak"
            | "bulletList"
            | "orderedList"
            | "listItem"
            | "tableHeadCell"
            | "tableBodyCell"
            | "lineBreak"
            | "htmlSource"
            | "htmlInlineSource",
            ToMdConvertor,
        >,
    >
    referenceDefinition?: boolean

    resolves link reference definitions ([label]: url)

    customHTMLSanitizer?: Sanitizer

    replaces the default, DOMPurify-based sanitizer

    previewHighlight?: boolean

    highlights the preview element at the cursor; true by default

    cursorLineHighlight?: boolean

    highlights the cursor line in the markdown editor; true by default

    frontMatter?: boolean

    reads a --- block at the start as front matter

    widgetRules?: WidgetRule[]

    see docs/widget.md

    theme?: string

    light, dark or a custom theme, see docs/theming.md; light by default

    autofocus?: boolean

    true by default

    viewer?: boolean

    creates a Viewer instead, with EditorCore.factory()

    stripPastedStyles?: boolean

    removes inline styles from HTML pasted into the WYSIWYG editor

    editPanel?: EditPanelOptions
    toolbarStyle?: ToolbarStyle

    wrap wraps the toolbar instead of moving the items that don't fit into a "More" menu

    Settings
    Member Visibility

    On This Page
    Properties