Trilium Frontend API
    Preparing search index...

    Interface ContextWatchdogItemConfiguration

    The watchdog item configuration interface.

    interface ContextWatchdogItemConfiguration {
        config: EditorConfig;
        creator: EditorWatchdogCreatorFunction;
        destructor?: (editor: Editor) => Promise<unknown>;
        id: string;
        sourceElementOrData?: string | HTMLElement;
        type: "editor";
    }
    Index

    Properties

    config creator destructor? id sourceElementOrData? type

    Properties

    config: EditorConfig

    An editor configuration.

    creator: EditorWatchdogCreatorFunction

    A function that initializes the item (the editor). The function takes the editor configuration and should return a promise. For example: config => ClassicEditor.create( config ).

    destructor?: (editor: Editor) => Promise<unknown>

    A function that destroys the item instance (the editor). The function takes an item and should return a promise. For example: editor => editor.destroy()

    id: string

    id A unique item identificator.

    sourceElementOrData?: string | HTMLElement

    The source element or data that will be passed as the first argument to the Editor.create() method.

    When not provided, the watchdog will use config-based creator mode, passing only the #config to the editor creator.

    type: "editor"

    The type of the item to create. At the moment, only 'editor' is supported.

    Settings

    Member Visibility

    On This Page

    Properties