Interface ComboboxProps

Whether the ComboBox allows a non-item matching input value to be set.

Whether the combo box allows the menu to be open when the collection is empty.

Identifies the element (or elements) that describes the object.

Identifies the element (or elements) that provide a detailed, extended description for the object.

Defines a string value that labels the current element.

Identifies the element (or elements) that labels the current element.

Whether the element should receive focus on render.

The children of the component. A function may be provided to alter the children based on component state.

The filter function used to determine if a option should be included in the combo box list.

The default value of the ComboBox input (uncontrolled).

The list of ComboBox items (uncontrolled).

The initial selected key in the collection (uncontrolled).

The default value (uncontrolled).

The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.

The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.

Whether the text or key of the selected item is submitted as part of an HTML form. When allowsCustomValue is true, this option does not apply and the text is always submitted.

The element's unique identifier. See MDN.

The value of the ComboBox input (controlled).

Whether the input is disabled.

Whether the input value is invalid.

Whether the input can be selected but not changed by the user.

The list of ComboBox items (controlled).

The interaction required to display the ComboBox menu.

The name of the input element, used when submitting an HTML form. See MDN.

Handler that is called when the element loses focus.

Handler that is called when the value changes.

Handler that is called when the element receives focus.

Handler that is called when the element's focus status changes.

Handler that is called when the ComboBox input value changes.

Handler that is called when a key is pressed.

Handler that is called when a key is released.

Method that is called when the open state of the menu changes. Returns the new open state and the action that caused the opening of the menu.

Handler that is called when the selection changes.

Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

Requirements:

• You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
• Only a single root DOM element can be rendered (no fragments).
• You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.

The currently selected key in the collection (controlled).

Whether single or multiple selection is enabled.

Whether keyboard navigation is circular.

A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

The inline style for the element. A function may be provided to compute the style based on component state.

A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.

Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.

The current value (controlled).