Interface ButtonActionDefinition

An action definition that provides a button.

interface ButtonActionDefinition {
    icon?: string;
    id: string;
    isDisabledForItem?(item): boolean;
    isVisibleForItem?(item): boolean | Promise<boolean>;
    label?: string;
    trigger(item): void;
}

Hierarchy (view full)

Properties

icon? id label?

Methods

isDisabledForItem? isVisibleForItem? trigger

Properties

Optional Readonly icon

icon?: string

Icon of the menu entry.

Readonly id

id: string

This action's unique id.

Optional Readonly label

label?: string

A textual label (or title) for this action.

Methods

Optional isDisabledForItem

  • isDisabledForItem(item): boolean

  • Method to decide if the action should be shown as disabled (optional).

    Parameters

    Returns boolean

Optional isVisibleForItem

  • isVisibleForItem(item): boolean | Promise<boolean>

  • Returns true if the action shall be available for the given item. Should return false otherwise.

    Note that this method may be asynchronous (i.e. return a Promise<boolean>).

    Parameters

    Returns boolean | Promise<boolean>

trigger

  • trigger(item): void

  • Called if the menu item is clicked.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

iconidlabelisDisabledForItemisVisibleForItemtrigger

Generated using TypeDoc