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

    Interface VirtualListData<TItem>

    Stateful data accepted by the Blessed virtualList adapter.

    interface VirtualListData<TItem extends ListItem = ListItem> {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        foregroundTone?: keyof ThemeColors;
        theme?: Theme;
        defaultOffset?: number;
        onOffsetChange?: (offset: number) => void;
        offset?: number;
        items: readonly TItem[];
        overscan?: number;
        activeId?: string;
        characters?: ListCharacters;
        emptyText?: string;
        selectedId?: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? foregroundTone? theme? defaultOffset? onOffsetChange? offset? items overscan? activeId? characters? emptyText? selectedId?

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    foregroundTone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    theme?: Theme

    Semantic terminal theme.

    defaultOffset?: number

    Initial first visible source index.

    onOffsetChange?: (offset: number) => void

    Called after keyboard or imperative scrolling changes the offset.

    offset?: number

    Controlled first visible source index.

    items: readonly TItem[]

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

    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.

    Settings

    Member Visibility

    On This Page

    Properties