Interface BaseActionDefinition

Properties shared by all action definitions.

interface BaseActionDefinition {
    id: string;
    isVisibleForItem(item: TocItem): boolean | Promise<boolean>;
    label?: string;
    type: ActionType;
}

Hierarchy (View Summary)

Properties

id label? type

Methods

isVisibleForItem?

Properties

Readonlyid

id: string

This action's unique id.

Optional Readonlylabel

label?: string

A textual label (or title) for this action.

Readonlytype

type: ActionType

The type of this action.

Methods

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>

Settings

Member Visibility

On This Page

Properties
Methods