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

    Interface GroupedListData<TItem>

    Stateful data accepted by the Blessed groupedList adapter.

    interface GroupedListData<TItem extends GroupedListItem = GroupedListItem> {
        activeId?: string;
        characters?: GroupedListCharacters;
        defaultValue?: string;
        emptyText?: string;
        indent?: number;
        sections: readonly GroupedListSection<TItem>[];
        onActiveIdChange?: (activeId: string) => void;
        onValueChange?: (value: string) => void;
        value?: string;
    }

    Type Parameters

    Index

    Properties

    activeId? characters? defaultValue? emptyText? indent? sections onActiveIdChange? onValueChange? value?

    Properties

    activeId?: string

    Preferred initial cursor identifier.

    characters?: GroupedListCharacters

    Character tokens used by the pure renderer.

    defaultValue?: string

    Initial selection for uncontrolled usage. Ignored when value is supplied.

    emptyText?: string

    Text displayed when no rows exist.

    indent?: number

    Spaces inserted before item rows.

    2

    sections: readonly GroupedListSection<TItem>[]

    Ordered sections. Disabled items are visible but not interactive.

    onActiveIdChange?: (activeId: string) => void

    Called after the cursor moves to a different enabled item.

    onValueChange?: (value: string) => void

    Called when Enter or GroupedListHandle.selectActive requests selection.

    value?: string

    Controlled selected identifier.

    Settings

    Member Visibility

    On This Page

    Properties