Trilium Frontend API
    Preparing search index...

    Interface MenuCommandItem<T>

    interface MenuCommandItem<T> {
        badges?: MenuItemBadge[];
        checked?: boolean;
        className?: string;
        columns?: number;
        command?: T;
        enabled?: boolean;
        handler?: MenuHandler<T>;
        iconColorClass?: string;
        items?: MenuItem<T>[];
        keyboardShortcut?:
            | "backInNoteHistory"
            | "forwardInNoteHistory"
            | "jumpToNote"
            | "commandPalette"
            | "scrollToActiveNote"
            | "quickSearch"
            | "searchInSubtree"
            | "expandSubtree"
            | "collapseTree"
            | "collapseSubtree"
            | "sortChildNotes"
            | "toggleArchivedNotes"
            | "createNoteAfter"
            | "createNoteInto"
            | "createNoteIntoInbox"
            | "deleteNotes"
            | "moveNoteUp"
            | "moveNoteDown"
            | "moveNoteUpInHierarchy"
            | "moveNoteDownInHierarchy"
            | "editNoteTitle"
            | "editBranchPrefix"
            | "cloneNotesTo"
            | "moveNotesTo"
            | "copyNotesToClipboard"
            | "pasteNotesFromClipboard"
            | "cutNotesToClipboard"
            | "selectAllNotesInParent"
            | "addNoteAboveToSelection"
            | "addNoteBelowToSelection"
            | "duplicateSubtree"
            | "openNewTab"
            | "closeActiveTab"
            | "reopenLastTab"
            | "activateNextTab"
            | "activatePreviousTab"
            | "openNewWindow"
            | "openTodayNote"
            | "toggleTray"
            | "toggleZenMode"
            | "firstTab"
            | "secondTab"
            | "thirdTab"
            | "fourthTab"
            | "fifthTab"
            | "sixthTab"
            | "seventhTab"
            | "eigthTab"
            | "ninthTab"
            | "lastTab"
            | "openNewNoteSplit"
            | "closeActiveNoteSplit"
            | "moveActiveNoteSplitLeft"
            | "moveActiveNoteSplitRight"
            | "focusNoteSplitLeft"
            | "focusNoteSplitRight"
            | "showNoteSource"
            | "showOptions"
            | "showRevisions"
            | "showRecentChanges"
            | "showDeletedNotes"
            | "showSQLConsole"
            | "showBackendLog"
            | "showSpaceUsage"
            | "showCheatsheet"
            | "showShortcutHints"
            | "showHelp"
            | "addLinkToText"
            | "followLinkUnderCursor"
            | "insertDateTimeToText"
            | "pasteMarkdownIntoText"
            | "cutIntoNote"
            | "addIncludeNoteToText"
            | "editReadOnlyNote"
            | "addNewLabel"
            | "addNewRelation"
            | "toggleRibbonTabClassicEditor"
            | "toggleRibbonTabBasicProperties"
            | "toggleRibbonTabBookProperties"
            | "toggleRibbonTabFileProperties"
            | "toggleRibbonTabImageProperties"
            | "toggleRibbonTabOwnedAttributes"
            | "toggleRibbonTabInheritedAttributes"
            | "toggleRibbonTabPromotedAttributes"
            | "toggleRibbonTabNoteMap"
            | "toggleRibbonTabNoteInfo"
            | "toggleRibbonTabNotePaths"
            | "toggleRibbonTabSimilarNotes"
            | "toggleRightPane"
            | "peekRightPane"
            | "printActiveNote"
            | "exportAsPdf"
            | "openNoteExternally"
            | "renderActiveNote"
            | "runActiveNote"
            | "toggleNoteHoisting"
            | "unhoist"
            | "reloadFrontendApp"
            | "openDevTools"
            | "findInText"
            | "toggleLeftPane"
            | "toggleFullscreen"
            | "zoomOut"
            | "zoomIn"
            | "zoomReset"
            | "copyWithoutFormatting"
            | "forceSaveRevision"
            | "saveNamedRevision";
        mime?: string;
        shortcut?: string;
        spellingSuggestion?: string;
        templateNoteId?: string;
        title: string;
        trailingIcon?: string;
        type?: string;
        uiIcon?: string;
    }

    Type Parameters

    • T
    Index
    badges? checked? className? columns? command? enabled? handler? iconColorClass? items? keyboardShortcut? mime? shortcut? spellingSuggestion? templateNoteId? title trailingIcon? type? uiIcon?
    badges?: MenuItemBadge[]
    checked?: boolean
    className?: string

    Classes put on the item itself, for a menu styling one of its entries differently.

    columns?: number
    command?: T
    enabled?: boolean
    handler?: MenuHandler<T>
    iconColorClass?: string

    Classes tinting uiIcon with the colour of whatever the item stands for, as cssClassManager.createClassForColor() and FNote#getColorClass() return them. Only the icon is tinted, the label staying readable against the highlight.

    items?: MenuItem<T>[]
    keyboardShortcut?:
        | "backInNoteHistory"
        | "forwardInNoteHistory"
        | "jumpToNote"
        | "commandPalette"
        | "scrollToActiveNote"
        | "quickSearch"
        | "searchInSubtree"
        | "expandSubtree"
        | "collapseTree"
        | "collapseSubtree"
        | "sortChildNotes"
        | "toggleArchivedNotes"
        | "createNoteAfter"
        | "createNoteInto"
        | "createNoteIntoInbox"
        | "deleteNotes"
        | "moveNoteUp"
        | "moveNoteDown"
        | "moveNoteUpInHierarchy"
        | "moveNoteDownInHierarchy"
        | "editNoteTitle"
        | "editBranchPrefix"
        | "cloneNotesTo"
        | "moveNotesTo"
        | "copyNotesToClipboard"
        | "pasteNotesFromClipboard"
        | "cutNotesToClipboard"
        | "selectAllNotesInParent"
        | "addNoteAboveToSelection"
        | "addNoteBelowToSelection"
        | "duplicateSubtree"
        | "openNewTab"
        | "closeActiveTab"
        | "reopenLastTab"
        | "activateNextTab"
        | "activatePreviousTab"
        | "openNewWindow"
        | "openTodayNote"
        | "toggleTray"
        | "toggleZenMode"
        | "firstTab"
        | "secondTab"
        | "thirdTab"
        | "fourthTab"
        | "fifthTab"
        | "sixthTab"
        | "seventhTab"
        | "eigthTab"
        | "ninthTab"
        | "lastTab"
        | "openNewNoteSplit"
        | "closeActiveNoteSplit"
        | "moveActiveNoteSplitLeft"
        | "moveActiveNoteSplitRight"
        | "focusNoteSplitLeft"
        | "focusNoteSplitRight"
        | "showNoteSource"
        | "showOptions"
        | "showRevisions"
        | "showRecentChanges"
        | "showDeletedNotes"
        | "showSQLConsole"
        | "showBackendLog"
        | "showSpaceUsage"
        | "showCheatsheet"
        | "showShortcutHints"
        | "showHelp"
        | "addLinkToText"
        | "followLinkUnderCursor"
        | "insertDateTimeToText"
        | "pasteMarkdownIntoText"
        | "cutIntoNote"
        | "addIncludeNoteToText"
        | "editReadOnlyNote"
        | "addNewLabel"
        | "addNewRelation"
        | "toggleRibbonTabClassicEditor"
        | "toggleRibbonTabBasicProperties"
        | "toggleRibbonTabBookProperties"
        | "toggleRibbonTabFileProperties"
        | "toggleRibbonTabImageProperties"
        | "toggleRibbonTabOwnedAttributes"
        | "toggleRibbonTabInheritedAttributes"
        | "toggleRibbonTabPromotedAttributes"
        | "toggleRibbonTabNoteMap"
        | "toggleRibbonTabNoteInfo"
        | "toggleRibbonTabNotePaths"
        | "toggleRibbonTabSimilarNotes"
        | "toggleRightPane"
        | "peekRightPane"
        | "printActiveNote"
        | "exportAsPdf"
        | "openNoteExternally"
        | "renderActiveNote"
        | "runActiveNote"
        | "toggleNoteHoisting"
        | "unhoist"
        | "reloadFrontendApp"
        | "openDevTools"
        | "findInText"
        | "toggleLeftPane"
        | "toggleFullscreen"
        | "zoomOut"
        | "zoomIn"
        | "zoomReset"
        | "copyWithoutFormatting"
        | "forceSaveRevision"
        | "saveNamedRevision"
    mime?: string
    shortcut?: string
    spellingSuggestion?: string
    templateNoteId?: string
    title: string
    trailingIcon?: string

    An icon shown at the trailing edge of the item, where a shortcut would go.

    Unlike checked, which takes the place of uiIcon, this leaves the item's own icon standing — for a list where that icon is what tells one entry from another.

    type?: string
    uiIcon?: string

    The icon to display in the menu item.

    If not set, no icon is displayed and the item will appear shifted slightly to the left if there are other items with icons. To avoid this, use bx bx-empty.

    Settings
    Member Visibility

    On This Page
    Properties