Trevixal API
    Preparing search index...

    Interface FullEditorOptions

    Copy for the header this layout puts above the editor.

    interface FullEditorOptions {
        aboutRows?: readonly AboutRow[];
        author?: string;
        autoLockMinutes?: number;
        checkLinkURL?:
            | ((href: string) => Promise<"ok" | "broken" | "unknown">)
            | null;
        content?: NodeJSON;
        element: HTMLElement;
        fetchLinkTitle?: (href: string) => Promise<string | null>;
        fetchPage?: (url: string) => Promise<string>;
        heading?: string | null;
        languages?: Readonly<
            Record<string, () => Promise<Readonly<Record<string, string>>>>,
        >;
        mapAttribution?: string;
        mapTiles?: string;
        maxImageBytes?: number;
        namespace?: string;
        onChange?: (editor: Editor) => void;
        onMention?: (event: MentionEvent) => void;
        paragraphs?: readonly string[];
        placeholder?: string;
        plantumlServer?: string | null;
        serializedHTMLLabel?: string;
        showSerializedHTML?: boolean;
        thesaurus?: SynonymLookup | null;
        uploadEndpoint?: string | null;
        users?: readonly MentionUser[];
        writingProvider?: WritingProvider | null;
    }

    Hierarchy (View Summary)

    Index
    aboutRows?: readonly AboutRow[]

    Extra rows for the About dialog, after the package's own.

    author?: string

    Whose name goes on a suggestion while track changes is on.

    autoLockMinutes?: number

    Minutes with nothing typed, clicked or scrolled before a password-protected document locks the screen until the password is given again. 10 by default; 0 turns the timer off, leaving File ▸ Lock now.

    checkLinkURL?: ((href: string) => Promise<"ok" | "broken" | "unknown">) | null

    Whether an outside address answers, for Tools ▸ Check links. Defaults to a request with no CORS, which tells a dead address from a live one; pass null for a check that stays offline.

    content?: NodeJSON

    The document to open with. Defaults to the tour of every block type.

    element: HTMLElement

    The element to build into. It is emptied first, so give the editor one of its own rather than a box that already holds something.

    fetchLinkTitle?: (href: string) => Promise<string | null>

    A pasted link's page title, fetched by the host, as uploads are sent: with it, a pasted address shows as its page's title. Without it, the editor asks nothing of the network and the address stays as pasted.

    fetchPage?: (url: string) => Promise<string>

    A web page's HTML, for File ▸ Import from a web address. The browser can only fetch a page that allows it, so a host with a server passes one that fetches on the server's side. Without it, the browser tries directly.

    heading?: string | null

    The page heading. Plain text; pass null for no heading at all.

    languages?: Readonly<
        Record<string, () => Promise<Readonly<Record<string, string>>>>,
    >

    The chrome's translations, by language code, each loaded only when it is chosen: { de: () => import('@trevixal/ui/locales/de').then((m) => m.default) }. With any given, View ▸ Language offers them beside English, and the choice is remembered. Arabic mirrors the chrome.

    mapAttribution?: string

    The credit the map tiles ask for.

    mapTiles?: string

    A map tile URL template, {z}, {x} and {y} in it, for Insert ▸ Map: any provider's. OpenStreetMap's by default, with its credit.

    maxImageBytes?: number

    Refuse an image larger than this, in bytes. Default 5 MB.

    namespace?: string

    The prefix under which preferences, the autosave draft, its backups and the document workspace are kept in localStorage. Give two editors on one origin two namespaces and neither reads the other's drafts; give them the same one and they share, which is sometimes the point.

    onChange?: (editor: Editor) => void

    Called after every change, once the readouts have been refreshed.

    onMention?: (event: MentionEvent) => void

    Called once for each person a new comment or reply mentions, to send them a note.

    paragraphs?: readonly string[]

    Paragraphs under the heading, each an HTML string so it can carry <code> and <strong>. It is written into the page as markup, so pass copy you control, never anything a reader typed.

    placeholder?: string

    The grey text in an empty document.

    plantumlServer?: string | null

    The PlantUML server that draws PlantUML blocks; the public one by default. A diagram's source goes to it in the picture's address, so pass your own server, or null to leave PlantUML undrawn.

    serializedHTMLLabel?: string

    Heading over that readout.

    showSerializedHTML?: boolean

    The readout that shows the HTML a download would produce. Default true.

    thesaurus?: SynonymLookup | null

    Synonyms for Right-click ▸ a word: a function over your own word list or a thesaurus service. A small built-in English list by default; null leaves right-click to the browser.

    uploadEndpoint?: string | null

    Where dropped images and attachments are POSTed. The upload falls back to a data URL when the endpoint is missing or refuses, so a build with no server still works; pass null to skip the request and go straight to the data URL.

    users?: readonly MentionUser[]

    The people a comment can mention with @; none by default.

    writingProvider?: WritingProvider | null

    The writing assistant behind Tools ▸ Writing assistant: an object with the actions it can do and an assist that does one. The kit sends nothing anywhere itself; by default it rewrites and summarises by rule, in the page. Pass a provider over your own model to rewrite, summarise, translate and continue; null hides the menu.