blessed-components - v1.20.0
    Preparing search index...

    Interface TabListHandle<TItem>

    Imperative handle returned by tabList.

    interface TabListHandle<TItem extends TabListItem = TabListItem> {
        activateFocused(): string | undefined;
        activeId(): string | undefined;
        focus(): void;
        focusItem(id: string): string | undefined;
        first(): string | undefined;
        last(): string | undefined;
        next(): string | undefined;
        previous(): string | undefined;
        value(): string | undefined;
        element: BoxElement;
        destroy(): void;
        setData(data: TabListData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Activates the focused trigger or emits a controlled activation request.

      Returns string | undefined

    • Moves focus to an enabled trigger identifier.

      Parameters

      • id: string

      Returns string | undefined

    • Moves focus to the next enabled trigger, wrapping at the end.

      Returns string | undefined

    • Moves focus to the previous enabled trigger, wrapping at the start.

      Returns string | undefined

    • Returns the current controlled or uncontrolled active trigger identifier.

      Returns string | undefined