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

    Interface MultiSelectData<TItem>

    Stateful data accepted by the Blessed multiSelect adapter.

    interface MultiSelectData<TItem extends MultiSelectItem = MultiSelectItem> {
        activeId?: string;
        characters?: MultiSelectCharacters;
        defaultValues?: readonly string[];
        emptyText?: string;
        items: readonly TItem[];
        onActiveIdChange?: (activeId: string) => void;
        onOpenChange?: (open: boolean) => void;
        onValuesChange?: (values: readonly string[]) => void;
        open?: boolean;
        placeholder?: string;
        values?: readonly string[];
    }

    Type Parameters

    Index

    Properties

    activeId? characters? defaultValues? emptyText? items onActiveIdChange? onOpenChange? onValuesChange? open? placeholder? values?

    Properties

    activeId?: string

    Preferred initial cursor identifier.

    characters?: MultiSelectCharacters

    Character tokens used by the pure renderer.

    defaultValues?: readonly string[]

    Initial selection for uncontrolled usage. Ignored when values is supplied.

    emptyText?: string

    Text displayed when no options exist.

    items: readonly TItem[]

    Ordered options. Disabled options are visible but not interactive.

    onActiveIdChange?: (activeId: string) => void

    Called after the cursor moves to a different enabled option.

    onOpenChange?: (open: boolean) => void

    Called after the open state changes.

    onValuesChange?: (values: readonly string[]) => void

    Called when selection changes or a controlled selection is requested.

    open?: boolean

    Controlled open state.

    placeholder?: string

    Text shown when no values are selected.

    values?: readonly string[]

    Controlled selected option identifiers.

    Settings

    Member Visibility

    On This Page

    Properties