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

    Interface GroupedListHandle<TItem>

    Imperative handle returned by groupedList.

    interface GroupedListHandle<TItem extends GroupedListItem = GroupedListItem> {
        activeId(): string | undefined;
        focus(): void;
        focusItem(id: string): string | undefined;
        first(): string | undefined;
        last(): string | undefined;
        next(): string | undefined;
        pageBackward(): string | undefined;
        pageForward(): string | undefined;
        previous(): string | undefined;
        selectActive(): string | undefined;
        value(): string | undefined;
        element: BoxElement;
        destroy(): void;
        setData(data: GroupedListData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves the cursor to an enabled identifier.

      Parameters

      • id: string

      Returns string | undefined