platform-bible-utils
    Preparing search index...

    Type Alias MenuItemBase

    MenuItemBase: OrderedItem & {
        disabled?: boolean;
        enabledWhen?: string;
        group: ReferencedItem;
        hiddenInterfaceModes?: InterfaceMode[];
        iconNameAfter?: string;
        iconNameBefore?: string;
        label: LocalizeKey;
        localizeNotes: string;
        searchTerms?: LocalizeKey;
        tooltip?: LocalizeKey;
        when?: string;
    }

    Type declaration

    • Optional Experimentaldisabled?: boolean

      Whether this menu item is currently disabled. Computed at runtime from MenuItemBase.enabledWhen by evaluateMenu — NOT allowed in menus.json contributions (rejected by the schema).

      This field is unstable and may change or disappear without notice

    • Optional ExperimentalenabledWhen?: string

      When-expression controlling whether this menu item is enabled. If not provided, the item is always enabled. Same grammar as MenuItemBase.when.

      This field is unstable and may change or disappear without notice

    • group: ReferencedItem

      Menu group to which this menu item belongs

    • OptionalhiddenInterfaceModes?: InterfaceMode[]

      Interface modes in which this menu item should be hidden. Omit (or use an empty array) for items that should show in every mode — most items need no value here at all.

    • Optional ExperimentaliconNameAfter?: string

      Lucide icon name (kebab-case, e.g. external-link) identifying the icon to display after the menu text. The icon takes the text colour of the item. The curated names are listed in LUCIDE_ICON_NAMES (exported from platform-bible-react/experimental). Wins over iconPathAfter when both are set, unless the name is not in that set: then iconPathAfter is shown if set, else no icon.

      This field is unstable and may change or disappear without notice

    • Optional ExperimentaliconNameBefore?: string

      Lucide icon name (kebab-case, e.g. refresh-cw) identifying the icon to display before the menu text. The icon takes the text colour of the item. The curated names are listed in LUCIDE_ICON_NAMES (exported from platform-bible-react/experimental). Wins over iconPathBefore when both are set, unless the name is not in that set: then iconPathBefore is shown if set, else no icon.

      This field is unstable and may change or disappear without notice

    • label: LocalizeKey

      Key that represents the text of this menu item to display

    • localizeNotes: string

      Additional information provided by developers to help people who perform localization

    • OptionalsearchTerms?: LocalizeKey

      Key that represents words the platform should reference when users are searching for menu items

    • Optionaltooltip?: LocalizeKey

      Key that represents the text to display if a mouse pointer hovers over the menu item

    • Optional Experimentalwhen?: string

      When-expression controlling whether this menu item is visible. If not provided, the item is always visible. Expressions reference context keys (see papi.contextKeys) and support && || ! == != ( ), single-quoted strings, numbers, true/false, and {templateVar} segments in property references (web view menus provide {webViewId}, {webViewType}, and {projectId}; the main menu provides none). Example: "myExtension.project.{projectId}.isEditable && !platform.someFlag"

      This field is unstable and may change or disappear without notice