@mendix/extensions-api - v0.2.4
    Preparing search index...

    Type Alias Menu

    type Menu = {
        caption: string;
        commandId?: string;
        enabled?: boolean;
        hasSeparatorAfter?: boolean;
        hasSeparatorBefore?: boolean;
        menuId: string;
        subMenus?: Menu[];
    }
    Index

    Properties

    caption commandId? enabled? hasSeparatorAfter? hasSeparatorBefore? menuId subMenus?

    Properties

    caption: string

    The display text of the menu.

    commandId?: string

    The id of the command that will be invoked when the menu is clicked. If the command is not registered first through the CommandRegistrationApi, an error will occur when the menu gets clicked.

    enabled?: boolean

    If not provided, the menu is enabled by default. Its enabled state can be updated with the 'update' call.

    hasSeparatorAfter?: boolean

    If true, a separator will be placed under this menu in the UI.

    hasSeparatorBefore?: boolean

    If true, a separator will be placed above this menu in the UI.

    menuId: string

    This ID should be unique and not empty. When the menu gets clicked, the message 'menuItemActivated' with this menuId as data is sent back to the extension.

    subMenus?: Menu[]

    The children menus of this menu. They can also be parents of other menus.

    Settings

    On This Page

    Properties