Trevixal API
    Preparing search index...

    Interface EditorOptions

    interface EditorOptions {
        announce?: boolean;
        ariaLabel?: string;
        autofocus?: boolean;
        content?: NodeJSON;
        doc?: EditorNode;
        editable?: boolean;
        element?: HTMLElement | null;
        history?: HistoryOptions;
        inputRules?: readonly InputRule[];
        keymap?: Readonly<Record<string, KeyBinding>>;
        maxLength?: number;
        nodeViews?: Readonly<Record<string, NodeViewFactory>>;
        onChange?: (change: EditorChange) => void;
        placeholder?: string;
        schema: Schema;
        spellcheck?: boolean;
    }
    Index
    announce? ariaLabel? autofocus? content? doc? editable? element? history? inputRules? keymap? maxLength? nodeViews? onChange? placeholder? schema spellcheck?
    announce?: boolean

    Announce structural edits to assistive technology; see EditorViewOptions.announce. On by default. Ignored without an element: a headless editor has no live region to write to.

    ariaLabel?: string

    Accessible name for the surface; see EditorViewOptions.ariaLabel.

    autofocus?: boolean

    Optional Readonlycontent

    content?: NodeJSON

    Initial content as canonical JSON.

    doc?: EditorNode
    editable?: boolean

    Start read-only. Flip at runtime with Editor.setEditable.

    element?: HTMLElement | null

    Mount point for the contenteditable view. Omit for a headless editor.

    history?: HistoryOptions
    inputRules?: readonly InputRule[]

    Replaces the default markdown-style input rules when provided.

    keymap?: Readonly<Record<string, KeyBinding>>

    Extra key bindings for the view; they win over the base keymap.

    maxLength?: number

    Reject edits that would push the character count past this limit.

    nodeViews?: Readonly<Record<string, NodeViewFactory>>

    Custom renderers per node type (framework components in the document).

    onChange?: (change: EditorChange) => void
    placeholder?: string

    Text shown while the document is empty.

    schema: Schema
    spellcheck?: boolean

    Browser spell checking on the editing surface. Left to the browser's default when omitted; flip at runtime with Editor.setSpellcheck.

    Settings
    Member Visibility

    On This Page
    Properties