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

    Interface RenderListOptions<TItem>

    Options accepted by renderList.

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

    Type Parameters

    • TItem extends ListItem = ListItem

      List item shape, including optional application metadata.

    Index

    Properties

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

    Properties

    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'

    height: number

    Maximum number of rendered rows.

    items: readonly TItem[]

    Ordered list items. Caller-owned data is never mutated.

    offset?: number

    First rendered item 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