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

    Interface MultiSelectHandle<TItem>

    Imperative handle returned by multiSelect.

    interface MultiSelectHandle<TItem extends MultiSelectItem = MultiSelectItem> {
        activeId(): string | undefined;
        clear(): boolean;
        close(): boolean;
        focus(): void;
        focusItem(id: string): string | undefined;
        next(): string | undefined;
        open(): boolean;
        opened(): boolean;
        previous(): string | undefined;
        toggle(): boolean;
        toggleActive(): readonly string[] | undefined;
        values(): readonly string[];
        element: BoxElement;
        destroy(): void;
        setData(data: MultiSelectData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves the cursor to an enabled identifier.

      Parameters

      • id: string

      Returns string | undefined