Interface BaseActionDefinition

Properties shared by all action definitions.

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

Hierarchy (view full)

BaseActionDefinition

Index

Properties

Methods

isVisibleForItem?

Properties

`Readonly` id

id: string

This action's unique id.

`Optional` `Readonly` label

label?: string

A textual label (or title) for this action.

`Readonly` type

type: ActionType

The type of this action.

Methods

`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
- item: TocItem
Returns boolean | Promise<boolean>
- Defined in Action.ts:44

Generated using TypeDoc