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

    Interface RenderGroupedListOptions<TItem>

    Options accepted by renderGroupedList.

    interface RenderGroupedListOptions<
        TItem extends GroupedListItem = GroupedListItem,
    > {
        sections: readonly GroupedListSection<TItem>[];
        activeId?: string;
        characters?: GroupedListCharacters;
        emptyText?: string;
        height: number;
        indent?: number;
        offset?: number;
        selectedId?: string;
        width: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    sections activeId? characters? emptyText? height indent? offset? selectedId? width

    Properties

    sections: readonly GroupedListSection<TItem>[]

    Ordered sections. Caller-owned data is never mutated.

    activeId?: string

    Identifier receiving the visible cursor marker.

    characters?: GroupedListCharacters

    Character tokens used to communicate row state without color.

    emptyText?: string

    Text returned when there are no visible rows.

    'No items'

    height: number

    Maximum number of rendered rows.

    indent?: number

    Spaces inserted before item rows.

    2

    offset?: number

    First rendered row index.

    0

    selectedId?: string

    Identifier receiving the selected marker.

    width: number

    Maximum terminal-cell width of each row.

    Settings

    Member Visibility

    On This Page

    Properties