Interface UseComboboxProps<T>

Whether to allow typing custom values in the input

Whether to always submit on Enter key press, even if popup is open. Useful for single-field autocomplete forms where Enter should submit the form.

Whether to autofocus the input on mount

Whether to close the combobox when an item is selected.

Whether the combobox is a composed with other composite widgets like tabs

The initial highlighted value of the combobox when rendered. Use when you don't need to control the highlighted value of the combobox.

The initial value of the combobox's input when rendered. Use when you don't need to control the value of the combobox's input.

The initial open state of the combobox when rendered. Use when you don't need to control the open state of the combobox.

The initial value of the combobox's selected items when rendered. Use when you don't need to control the value of the combobox's selected items.

Whether the combobox is disabled

Whether to disable registering this a dismissable layer

The associate form of the combobox.

The controlled highlighted value of the combobox

The unique identifier of the machine.

The ids of the elements in the combobox. Useful for composition.

Defines the auto-completion behavior of the combobox.

• autohighlight: The first focused item is highlighted as the user types
• autocomplete: Navigating the listbox with the arrow keys selects the item and the input is updated

The controlled value of the combobox's input

Whether the combobox is invalid

Whether to loop the keyboard navigation through the items

Whether to allow multiple selection.

Good to know: When multiple is true, the selectionBehavior is automatically set to clear. It is recommended to render the selected items in a separate container.

The name attribute of the combobox's input. Useful for form submission

Function to navigate to the selected item

Function called when the focus is moved outside the component

Function called when an item is highlighted using the pointer or keyboard navigation.

Function called when the input's value changes

Function called when an interaction happens outside the component

Function called when the popup is opened

Function called when the pointer is pressed down outside the component

Function called when an item is selected

Function called when a new item is selected

The controlled open state of the combobox

Whether to show the combobox when the input value changes

Whether to open the combobox popup on initial click on the input

Whether to open the combobox on arrow key press

The placeholder text of the combobox's input

The positioning options to dynamically position the menu

Whether the combobox is readonly. This puts the combobox in a "non-editable" mode but the user can still interact with it

Whether the combobox is required

Function to scroll to a specific index

The behavior of the combobox input when an item is selected

• replace: The selected item string is set as the input value
• clear: The input value is cleared
• preserve: The input value is preserved

Specifies the localized strings that identifies the accessibility elements and their states

The controlled value of the combobox's selected items