Trevixal API
    Preparing search index...

    Interface EditorUIOptions

    interface EditorUIOptions {
        blockCommands?: BlockCommands;
        codeCommands?: CodeCommands;
        codeFormatCommands?: CodeFormatCommands;
        container: HTMLElement;
        diagramCommands?: DiagramCommands;
        embedCommands?: EmbedCommands;
        fileActions?: FileActions;
        images?: ImageActions;
        language?: Omit<ChromeLanguage, "messages">;
        links?: { checkURL?: (href: string) => Promise<LinkStatus> };
        mathCommands?: MathCommands;
        menus?: readonly Menu[];
        messages?: Readonly<Record<string, string>>;
        securityCommands?: SecurityCommands;
        shortcutLabels?: Readonly<Record<string, string | null>>;
        showMenubar?: boolean;
        showStatusBar?: boolean;
        snippets?: SnippetStore;
        tableCommands?: TableCommands;
        toolbar?: ToolbarOptions;
        viewActions?: ViewActions;
        workspaceCommands?: { includeDocument?: () => void };
    }
    Index
    blockCommands?: BlockCommands

    Advanced-block commands, from @trevixal/extension-blocks. Menu entries for blocks the host does not supply are removed rather than disabled.

    codeCommands?: CodeCommands

    Terminal, diff and runnable code blocks, from @trevixal/extension-code-highlight.

    codeFormatCommands?: CodeFormatCommands

    JSON/XML formatting, from @trevixal/extension-format-code.

    container: HTMLElement

    Mount point. The menubar, toolbar and status bar are appended here.

    diagramCommands?: DiagramCommands

    Diagrams, from @trevixal/extension-diagram.

    embedCommands?: EmbedCommands

    Media embeds, from @trevixal/extension-embed.

    fileActions?: FileActions

    Open, save, download, import and print.

    images?: ImageActions
    language?: Omit<ChromeLanguage, "messages">

    The language messages is in, as lang takes it, with its direction; English by default.

    links?: { checkURL?: (href: string) => Promise<LinkStatus> }

    Links: checkURL says whether an outside address answers, for Tools ▸ Check links. Without it, outside links are only checked for being well formed; the host decides whether the editor reaches out at all.

    mathCommands?: MathCommands

    Equations, from @trevixal/extension-math.

    menus?: readonly Menu[]
    messages?: Readonly<Record<string, string>>

    Translations for every label the chrome renders, keyed menu.<name> and toolbar.<name>. Anything missing keeps its English, so a partial catalogue is a working one. defaultMessages() lists every key.

    securityCommands?: SecurityCommands

    Redaction, locked sections and Lock now, from @trevixal/extension-security.

    shortcutLabels?: Readonly<Record<string, string | null>>

    Shortcut text printed beside menu entries, keyed by item name. Pass createShortcutManager().labels() so the menus print exactly the keys that fire. When given, the menus' own default labels are not used.

    showMenubar?: boolean

    Hide the menubar for a compact, toolbar-only editor.

    showStatusBar?: boolean

    Hide the word/character count bar.

    snippets?: SnippetStore

    Where snippets are kept. With it, Insert ▸ Snippet and Tools ▸ Snippets appear, and abbreviations expand as they are typed.

    tableCommands?: TableCommands
    toolbar?: ToolbarOptions
    viewActions?: ViewActions

    Host actions for chrome the UI does not own.

    workspaceCommands?: { includeDocument?: () => void }

    What the document workspace offers the Insert menu.

    Type Declaration

    • Optional ReadonlyincludeDocument?: () => void

      Include a document, or a block of one, kept in step with it.