Trevixal API
    Preparing search index...

    Interface FullEditorOptions

    Copy for the header this layout puts above the editor.

    interface FullEditorOptions {
        aboutRows?: readonly AboutRow[];
        author?: string;
        content?: NodeJSON;
        element: HTMLElement;
        heading?: string | null;
        maxImageBytes?: number;
        namespace?: string;
        onChange?: (editor: Editor) => void;
        paragraphs?: readonly string[];
        placeholder?: string;
        serializedHTMLLabel?: string;
        showSerializedHTML?: boolean;
        uploadEndpoint?: string | null;
    }

    Hierarchy (View Summary)

    Index
    aboutRows? author? content? element heading? maxImageBytes? namespace? onChange? paragraphs? placeholder? serializedHTMLLabel? showSerializedHTML? uploadEndpoint?
    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.

    Optional Readonlycontent

    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.

    heading?: string | null

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

    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.

    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.

    serializedHTMLLabel?: string

    Heading over that readout.

    showSerializedHTML?: boolean

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

    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.

    Settings
    Member Visibility

    On This Page
    Properties