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

    Interface RenderMultiSelectOptions<TItem>

    Options accepted by renderMultiSelect.

    interface RenderMultiSelectOptions<
        TItem extends MultiSelectItem = MultiSelectItem,
    > {
        activeId?: string;
        characters?: MultiSelectCharacters;
        emptyText?: string;
        height: number;
        items: readonly TItem[];
        open?: boolean;
        offset?: number;
        placeholder?: string;
        values?: readonly string[];
        width: number;
    }

    Type Parameters

    Index

    Properties

    activeId? characters? emptyText? height items open? offset? placeholder? values? width

    Properties

    activeId?: string

    Identifier receiving the visible focus marker when open.

    characters?: MultiSelectCharacters

    Character tokens used by the renderer.

    emptyText?: string

    Text returned when items is empty.

    'No options'

    height: number

    Maximum number of rendered rows.

    items: readonly TItem[]

    Ordered options. Caller-owned data is never mutated.

    open?: boolean

    Whether the option list is visible.

    offset?: number

    First rendered option index when open.

    0

    placeholder?: string

    Text shown when no values are selected.

    'Select options'

    values?: readonly string[]

    Selected option identifiers.

    width: number

    Maximum terminal-cell width of each row.

    Settings

    Member Visibility

    On This Page

    Properties