Trilium Frontend API
    Preparing search index...

    Type Alias EventMappings

    type EventMappings = {
        activeContextChanged: { noteContext: NoteContext };
        activeNoteChanged: { ntxId: string | null | undefined };
        activeScreenChanged: { activeScreen: Screen };
        addNewLabel: CommandData;
        addNewRelation: CommandData;
        apiLogMessages: { messages: string[]; noteId: string };
        beforeNoteContextRemove: { ntxIds: string[] };
        beforeNoteSwitch: { noteContext: NoteContext };
        cloneNoteIdsTo: { noteIds: string[] };
        contentElRefreshed: { contentEl: HTMLElement; ntxId?: string | null };
        contentSafeMarginChanged: { noteContext: NoteContext; top: number };
        contextDataChanged: {
            key: string;
            noteContext: NoteContext;
            value: unknown;
        };
        contextsReopened: {
            afterNtxId?: string;
            mainNtxId: string
            | null;
            ntxId?: string;
            tabPosition: number;
        };
        entitiesReloaded: { loadResults: default };
        exportCsv: { ntxId: string | null | undefined };
        exportPng: { ntxId: string | null | undefined };
        exportSvg: { ntxId: string | null | undefined };
        exportXlsx: { ntxId: string | null | undefined };
        frocaReloaded: {};
        geoMapCreateChildNote: { ntxId: string | null | undefined };
        hoistedNoteChanged: { noteId: string; ntxId: string | null };
        initialRenderComplete: {};
        newNoteContextCreated: { noteContext: NoteContext };
        noteContextRemoved: { ntxIds: string[] };
        noteContextReorder: {
            newMainNtxId: string;
            ntxIdsInOrder: string[];
            oldMainNtxId: string;
        };
        noteDetailRefreshed: { ntxId?: string
        | null };
        notesReloaded: { noteIds: string[] };
        noteSwitched: NoteSwitchedContext;
        noteSwitchedAndActivated: NoteSwitchedContext;
        noteTypeMimeChanged: { noteId: string };
        openBulkActionsDialog: { selectedOrActiveNoteIds: string[] };
        protectedSessionStarted: {};
        readOnlyTemporarilyDisabled: { noteContext: NoteContext };
        reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined };
        reEvaluateTocWidgetVisibility: { noteId: string | undefined };
        refreshData: { ntxId: string | null | undefined };
        refreshIncludedNote: { noteId: string };
        refreshNoteList: { noteId: string };
        relationMapCreateChildNote: { ntxId: string | null | undefined };
        relationMapResetPanZoom: { ntxId: string | null | undefined };
        relationMapResetZoomIn: { ntxId: string | null | undefined };
        relationMapResetZoomOut: { ntxId: string | null | undefined };
        searchRefreshed: { ntxId?: string | null };
        setLeftPaneVisibility: { leftPaneVisible: boolean | null };
        setNoteContext: { noteContext: NoteContext };
        shortcutHintsRequested: {
            anchor?: HTMLElement | null;
            sections: ShortcutHintSection[];
        };
        showAddLinkDialog: AddLinkOpts;
        showBoardProperties: { ntxId: string
        | null
        | undefined };
        showHighlightsListWidget: { noteId: string };
        showIncludeDialog: IncludeNoteOpts;
        showSearchError: { error: string };
        showTocWidget: { noteId: string };
        sqlQueryResults: CommandData & { response: SqlExecuteResponse };
        tabPinStateChanged: { ntxId: string | null; pinned: boolean };
        tabReorder: { ntxIdsInOrder: string[] };
        textEditorRefreshed: { editor: CKTextEditor; ntxId?: string | null };
        themeChanged: { themeStyle: "light" | "dark" };
        zenModeChanged: { isEnabled: boolean };
    }
    Index
    activeContextChanged activeNoteChanged activeScreenChanged addNewLabel addNewRelation apiLogMessages beforeNoteContextRemove beforeNoteSwitch cloneNoteIdsTo contentElRefreshed contentSafeMarginChanged contextDataChanged contextsReopened entitiesReloaded exportCsv exportPng exportSvg exportXlsx frocaReloaded geoMapCreateChildNote hoistedNoteChanged initialRenderComplete newNoteContextCreated noteContextRemoved noteContextReorder noteDetailRefreshed notesReloaded noteSwitched noteSwitchedAndActivated noteTypeMimeChanged openBulkActionsDialog protectedSessionStarted readOnlyTemporarilyDisabled reEvaluateHighlightsListWidgetVisibility reEvaluateTocWidgetVisibility refreshData refreshIncludedNote refreshNoteList relationMapCreateChildNote relationMapResetPanZoom relationMapResetZoomIn relationMapResetZoomOut searchRefreshed setLeftPaneVisibility setNoteContext shortcutHintsRequested showAddLinkDialog showBoardProperties showHighlightsListWidget showIncludeDialog showSearchError showTocWidget sqlQueryResults tabPinStateChanged tabReorder textEditorRefreshed themeChanged zenModeChanged
    activeContextChanged: { noteContext: NoteContext }
    activeNoteChanged: { ntxId: string | null | undefined }
    activeScreenChanged: { activeScreen: Screen }

    Triggered when the CommandMappings.setActiveScreen command is invoked.

    addNewLabel: CommandData
    addNewRelation: CommandData
    apiLogMessages: { messages: string[]; noteId: string }
    beforeNoteContextRemove: { ntxIds: string[] }
    beforeNoteSwitch: { noteContext: NoteContext }
    cloneNoteIdsTo: { noteIds: string[] }
    contentElRefreshed: { contentEl: HTMLElement; ntxId?: string | null }
    contentSafeMarginChanged: { noteContext: NoteContext; top: number }
    contextDataChanged: { key: string; noteContext: NoteContext; value: unknown }
    contextsReopened: {
        afterNtxId?: string;
        mainNtxId: string | null;
        ntxId?: string;
        tabPosition: number;
    }
    entitiesReloaded: { loadResults: default }
    exportCsv: { ntxId: string | null | undefined }
    exportPng: { ntxId: string | null | undefined }
    exportSvg: { ntxId: string | null | undefined }
    exportXlsx: { ntxId: string | null | undefined }
    frocaReloaded: {}
    geoMapCreateChildNote: { ntxId: string | null | undefined }
    hoistedNoteChanged: { noteId: string; ntxId: string | null }
    initialRenderComplete: {}
    newNoteContextCreated: { noteContext: NoteContext }
    noteContextRemoved: { ntxIds: string[] }
    noteContextReorder: {
        newMainNtxId: string;
        ntxIdsInOrder: string[];
        oldMainNtxId: string;
    }
    noteDetailRefreshed: { ntxId?: string | null }
    notesReloaded: { noteIds: string[] }
    noteSwitched: NoteSwitchedContext
    noteSwitchedAndActivated: NoteSwitchedContext
    noteTypeMimeChanged: { noteId: string }
    openBulkActionsDialog: { selectedOrActiveNoteIds: string[] }
    protectedSessionStarted: {}
    readOnlyTemporarilyDisabled: { noteContext: NoteContext }
    reEvaluateHighlightsListWidgetVisibility: { noteId: string | undefined }
    reEvaluateTocWidgetVisibility: { noteId: string | undefined }
    refreshData: { ntxId: string | null | undefined }
    refreshIncludedNote: { noteId: string }
    refreshNoteList: { noteId: string }
    relationMapCreateChildNote: { ntxId: string | null | undefined }
    relationMapResetPanZoom: { ntxId: string | null | undefined }
    relationMapResetZoomIn: { ntxId: string | null | undefined }
    relationMapResetZoomOut: { ntxId: string | null | undefined }
    searchRefreshed: { ntxId?: string | null }
    setLeftPaneVisibility: { leftPaneVisible: boolean | null }
    setNoteContext: { noteContext: NoteContext }
    shortcutHintsRequested: {
        anchor?: HTMLElement | null;
        sections: ShortcutHintSection[];
    }

    Emitted with the hints collected from the focused component chain (via the CommandMappings.showShortcutHints handler) or from a widget's help button, for the shortcut-hints pane to render. When anchor is set the pane opens as a dropdown by it; otherwise it opens in the bottom-right corner.

    showAddLinkDialog: AddLinkOpts
    showBoardProperties: { ntxId: string | null | undefined }

    Opens the board's properties dialog, which only the board itself can show.

    showHighlightsListWidget: { noteId: string }
    showIncludeDialog: IncludeNoteOpts
    showSearchError: { error: string }
    showTocWidget: { noteId: string }
    sqlQueryResults: CommandData & { response: SqlExecuteResponse }
    tabPinStateChanged: { ntxId: string | null; pinned: boolean }
    tabReorder: { ntxIdsInOrder: string[] }
    textEditorRefreshed: { editor: CKTextEditor; ntxId?: string | null }
    themeChanged: { themeStyle: "light" | "dark" }

    Triggered when the active theme changes (theme option swap or, for auto themes, the OS light/dark flip), once the new stylesheet is applied. Lets widgets that read CSS variables in JS (e.g. canvas renderers) re-read them. Consume with useTriliumEvent("themeChanged") or the useColorScheme hook.

    zenModeChanged: { isEnabled: boolean }

    Settings
    Member Visibility

    On This Page
    Properties
    activeContextChangedactiveNoteChangedactiveScreenChangedaddNewLabeladdNewRelationapiLogMessagesbeforeNoteContextRemovebeforeNoteSwitchcloneNoteIdsTocontentElRefreshedcontentSafeMarginChangedcontextDataChangedcontextsReopenedentitiesReloadedexportCsvexportPngexportSvgexportXlsxfrocaReloadedgeoMapCreateChildNotehoistedNoteChangedinitialRenderCompletenewNoteContextCreatednoteContextRemovednoteContextReordernoteDetailRefreshednotesReloadednoteSwitchednoteSwitchedAndActivatednoteTypeMimeChangedopenBulkActionsDialogprotectedSessionStartedreadOnlyTemporarilyDisabledreEvaluateHighlightsListWidgetVisibilityreEvaluateTocWidgetVisibilityrefreshDatarefreshIncludedNoterefreshNoteListrelationMapCreateChildNoterelationMapResetPanZoomrelationMapResetZoomInrelationMapResetZoomOutsearchRefreshedsetLeftPaneVisibilitysetNoteContextshortcutHintsRequestedshowAddLinkDialogshowBoardPropertiesshowHighlightsListWidgetshowIncludeDialogshowSearchErrorshowTocWidgetsqlQueryResultstabPinStateChangedtabReordertextEditorRefreshedthemeChangedzenModeChanged