Interface BulkButtonTableAction

An action that is displayed as a button in a table's menu bar.

interface BulkButtonTableAction {
    icon: string;
    id: string;
    label: string;
    priority?: number;
    provideDisplayState(dataTable: DataTable): Partial<TableActionDisplayState>;
    tooltip: string;
    trigger(actionContext: BulkActionContext): Promise<void>;
    uiType: "button";
}

Hierarchy (View Summary)

Properties

icon id label priority? tooltip uiType

Methods

provideDisplayState? trigger

Properties

Readonlyicon

icon: string

Icon of the button that will be rendered in the menu bar. *

Readonlyid

id: string

ID used to identify this action.

Readonlylabel

label: string

Label that might be rendered on a button beside or instead of the icon. *

Optional Readonlypriority

priority?: number

optional flag of actions used as source of ordering. *

Readonlytooltip

tooltip: string

Tooltip that is displayed, when hovering the button. *

ReadonlyuiType

uiType: "button"

Type of action that describes how it is rendered, e.g. as a button *

Methods

OptionalprovideDisplayState

  • provideDisplayState(dataTable: DataTable): Partial<TableActionDisplayState>

  • Actions can optionally provide a display state that controls if this action is visible or enabled in a table's menu bar.

    Parameters

    • dataTable: DataTable

      the table that requests the display state.

    Returns Partial<TableActionDisplayState>

trigger

  • trigger(actionContext: BulkActionContext): Promise<void>

  • Runs the action code.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods