Interface TextLabelActionDefinition

An action definition that provides a text label.

interface TextLabelActionDefinition {
    icon?: string;
    id: string;
    isVisibleForItem(item: TocItem): boolean | Promise<boolean>;
    label?: string;
    labelMore?: string;
    trigger(item: TocItem): void;
    truncationThreshold?: number;
    type: "text-label";
    valueOf(item: TocItem): undefined | string;
}

Hierarchy (View Summary)

Properties

icon? id label? labelMore? truncationThreshold? type

Methods

isVisibleForItem? trigger? valueOf

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.

Optional ReadonlylabelMore

labelMore?: string

Label for the "show more" link.

Optional ReadonlytruncationThreshold

truncationThreshold?: number

Threshold that defines when to auto shorten the text and provide a "show more" link instead.

If set to -1 text is never truncated.

Readonlytype

type: "text-label"

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>

Optionaltrigger

  • trigger(item: TocItem): void

  • Called when the "show more" link is clicked. Must be implemented if truncationThreshold is used.

    Parameters

    Returns void

valueOf

  • valueOf(item: TocItem): undefined | string

  • Returns a text representation for the given item.

    Parameters

    Returns undefined | string

Settings

Member Visibility

On This Page

Properties
Methods