UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface ComboboxOptions

    Combobox options for two controlled values, filtering, async suggestions, and positioning.

    interface ComboboxOptions {
        defaultInputValue?: string;
        defaultSelectedValue?: string | null;
        filter?: (option: Readonly<ComboboxOption>, query: string) => boolean;
        getInputValue?: () => string;
        getSelectedValue?: () => string | null;
        id?: string;
        loadOptions?: (
            query: string,
            signal: AbortSignal,
        ) => Promise<readonly ComboboxOption[]>;
        onInputValueChange?: (
            value: string,
            details: ChangeDetails<ComboboxInputReason>,
        ) => void;
        onSelectedValueChange?: (
            value: string | null,
            details: ChangeDetails<ComboboxSelectReason>,
        ) => void;
        positioning?: FloatingPositionOptions;
        subscribeInputValue?: (listener: () => void) => () => void;
        subscribeSelectedValue?: (listener: () => void) => () => void;
    }
    Index

    Properties

    defaultInputValue? defaultSelectedValue? filter? getInputValue? getSelectedValue? id? loadOptions? onInputValueChange? onSelectedValueChange? positioning? subscribeInputValue? subscribeSelectedValue?

    Properties

    defaultInputValue?: string

    Initial editable input value in uncontrolled mode.

    defaultSelectedValue?: string | null

    Initial selected value in uncontrolled mode.

    filter?: (option: Readonly<ComboboxOption>, query: string) => boolean

    Replaces the default fuzzy local matcher.

    getInputValue?: () => string

    Reads consumer-owned input value.

    getSelectedValue?: () => string | null

    Reads consumer-owned selected value.

    id?: string

    Deterministic ID prefix.

    loadOptions?: (
        query: string,
        signal: AbortSignal,
    ) => Promise<readonly ComboboxOption[]>

    Loads query-specific options; stale responses are ignored by request generation.

    onInputValueChange?: (
        value: string,
        details: ChangeDetails<ComboboxInputReason>,
    ) => void

    Receives accepted input requests.

    onSelectedValueChange?: (
        value: string | null,
        details: ChangeDetails<ComboboxSelectReason>,
    ) => void

    Receives accepted selection requests.

    positioning?: FloatingPositionOptions

    Popup positioning options shared with other anchored components.

    subscribeInputValue?: (listener: () => void) => () => void

    Subscribes to external input changes.

    subscribeSelectedValue?: (listener: () => void) => () => void

    Subscribes to external selection changes.

    Settings

    Member Visibility

    On This Page

    Properties