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

    Interface RenderVirtualListOptions<TItem>

    Options accepted by renderVirtualList.

    interface RenderVirtualListOptions<TItem extends ListItem = ListItem> {
        height: number;
        items: readonly TItem[];
        offset?: number;
        overscan?: number;
        activeId?: string;
        characters?: ListCharacters;
        emptyText?: string;
        selectedId?: string;
        width: number;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    height items offset? overscan? activeId? characters? emptyText? selectedId? width

    Properties

    height: number

    Number of visible rows.

    items: readonly TItem[]

    Full ordered item collection. Caller-owned data is never mutated.

    offset?: number

    First visible source index.

    0

    overscan?: number

    Extra rows retained before and after the visible viewport.

    0

    activeId?: string

    Identifier receiving the visible cursor marker.

    characters?: ListCharacters

    Character tokens used to communicate row state without color.

    emptyText?: string

    Text returned when items is empty.

    'No items'

    selectedId?: string

    Identifier receiving the selected marker.

    width: number

    Maximum terminal-cell width of each row.

    Settings

    Member Visibility

    On This Page

    Properties