@yarcl/react
    Preparing search index...

    Type Alias ComboboxProps<V>

    ComboboxProps: ComboboxBaseProps<V> & (
        | {
            defaultValue?: V
            | null;
            maxSelected?: never;
            multiple?: false;
            onValueChange?: (value: V | null) => void;
            value?: V | null;
        }
        | {
            defaultValue?: readonly V[];
            maxSelected?: number;
            multiple: true;
            onValueChange?: (value: V[]) => void;
            value?: readonly V[];
        }
    )

    Props for Combobox. multiple switches the value from one option to an array of them.

    Type Parameters

    • V extends string = string

    Type Declaration

    • {
          defaultValue?: V | null;
          maxSelected?: never;
          multiple?: false;
          onValueChange?: (value: V | null) => void;
          value?: V | null;
      }
      • OptionaldefaultValue?: V | null

        Initial selected value when uncontrolled.

      • OptionalmaxSelected?: never
      • Optionalmultiple?: false

        One value at a time. The input shows the selected option's label.

      • OptionalonValueChange?: (value: V | null) => void

        Called when an option is chosen, or with the typed text when allowCustomValue is set.

      • Optionalvalue?: V | null

        Controlled selected value. null means nothing is selected.

    • {
          defaultValue?: readonly V[];
          maxSelected?: number;
          multiple: true;
          onValueChange?: (value: V[]) => void;
          value?: readonly V[];
      }
      • OptionaldefaultValue?: readonly V[]

        Initial selected values when uncontrolled.

      • OptionalmaxSelected?: number

        The most values that can be selected. Other options are disabled once it is reached.

      • multiple: true

        Any number of values, shown as removable chips before the input.

      • OptionalonValueChange?: (value: V[]) => void

        Called with all selected values.

      • Optionalvalue?: readonly V[]

        Controlled selected values.