Interface ButtonActionDefinition

An action definition that provides a button.

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

Hierarchy (View Summary)

Properties

icon? id label? type

Methods

isDisabledForItem? isVisibleForItem? trigger

Properties

Optional Readonlyicon

icon?: string

Icon of the menu entry.

Readonlyid

id: string

This action's unique id.

Optional Readonlylabel

label?: string

A textual label (or title) for this action.

Readonlytype

type: "button"

The type of this action.

Methods

OptionalisDisabledForItem

  • isDisabledForItem(item: TocItem): boolean

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

    Parameters

    Returns boolean

OptionalisVisibleForItem

  • isVisibleForItem(item: TocItem): 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: TocItem): void

  • Called if the menu item is clicked.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods