Combobox

The input value of the combobox. Use when controlled.

The uncontrolled input value when initially rendered.

To render a controlled input, use the inputValue prop instead.

Whether the popup is currently open. Use when controlled.

Whether the popup is initially open.

To render a controlled popup, use the open prop instead.

The selected value of the combobox. Use when controlled.

The uncontrolled selected value of the combobox when it's initially rendered.

To render a controlled combobox, use the value prop instead.

Provides a hint to the browser for autofill.

Whether the first matching item is highlighted automatically while filtering.

Whether the component should ignore user interaction.

Filter function used to match items vs input query. Receives the source item, which is the derived value's item when items is a createItems() collection, and the item itself otherwise.

Filtered items to display in the list. When provided, the list uses these items instead of filtering the items prop internally. When items is also provided, this array must preserve its flat or grouped structure. With a createItems() collection, pass source items rather than derived values. Nullish entries are not supported, as in items. Use when you want to control filtering logic externally with the useFilter() hook.

Identifies the form that owns the internal input. Useful when the combobox is rendered outside the form.

Whether list items are presented in a grid layout. When enabled, arrow keys navigate across rows and columns inferred from DOM rows.

Whether moving the pointer over items should highlight them. Disabling this prop allows CSS :hover to be differentiated from the :focus (data-highlighted) state.

The id of the component.

Whether the list is rendered inline without using the component's own popup.

Specify open unconditionally in conjunction with this prop so the list is considered visible: <Combobox.Root inline open>

In a Combobox.Root > Dialog.Root composition, bind the Combobox's open and onOpenChange props to the Dialog's open and onOpenChange state instead so the component resets its transient state (filter query, highlighted item, and input value) when the dialog closes.

Custom comparison logic used to determine if a combobox item value matches the current selected value. Useful when item values are objects without matching referentially. With a createItems() collection, both arguments are derived values. Defaults to Object.is comparison.

The items to be displayed in the list. Can be a flat array of items, an array of groups with items, or a collection created by the createItems() function, which derives each item's selection value and label. Nullish entries are not supported: remove them from the data before passing it.

When the item values are objects (<Combobox.Item value={object}>), this function converts the object value to a string representation for display in the input. If the shape of the object is { value, label }, the label will be used automatically without needing to specify this prop. With a createItems() collection, this receives the derived value, and the collection's getLabel takes precedence for values it can resolve.

When the item values are objects (<Combobox.Item value={object}>), this function converts the object value to a string representation for form submission. If the shape of the object is { value, label }, the value will be used automatically without needing to specify this prop. With a createItems() collection, this receives the derived value.

The maximum number of items to display in the list.

The locale to use for string comparison. Defaults to the user's runtime locale.

Whether to loop keyboard focus back to the input when the end of the list is reached while using the arrow keys. The first item can then be reached by pressing <kbd>ArrowDown</kbd> again from the input, or the last item can be reached by pressing <kbd>ArrowUp</kbd> from the input. The input is always included in the focus loop per ARIA Authoring Practices. When disabled, focus does not move when on the last element and the user presses <kbd>ArrowDown</kbd>, or when on the first element and the user presses <kbd>ArrowUp</kbd>.

Determines if the popup enters a modal state when open.

• true: user interaction is limited to the popup: document page scroll is locked and pointer interactions on outside elements are disabled.
• false: user interaction with the rest of the document is allowed.

On touch devices, a true modal blocks outside taps but leaves the page scrollable unless the popup spans nearly the full viewport width, matching native iOS behavior.

Whether multiple items can be selected.

Identifies the field when a form is submitted.

Whether the popup opens when clicking the input.

Whether the user should be unable to choose a different option from the popup.

Whether the user must choose a value before submitting a form.

Whether the items are being externally virtualized.

A ref to imperative actions.

• unmount: Ends the closing phase of the combobox after an externally controlled closing animation finishes. Call preventUnmountOnClose() in onOpenChange first, otherwise the combobox completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.
• close: Closes the combobox imperatively when called.

A ref to the hidden input element.

Event handler called when the input value changes.

Event handler called when the popup is opened or closed.

Event handler called when the selected value of the combobox changes.

Callback fired when an item is highlighted or unhighlighted. Receives the highlighted item value (or undefined if no item is highlighted) and event details with a reason property describing why the highlight changed. The reason can be:

• 'keyboard': the highlight changed due to keyboard navigation.
• 'pointer': the highlight changed due to pointer hovering. The event may be a MouseEvent rather than a PointerEvent.
• 'none': the highlight changed for another reason, such as typing, autoHighlight, the item list changing, or the popup opening or closing.

Event handler called after any animations complete when the popup is opened or closed.

The accessible name of the clear button; required with it.

Whether the component should ignore user interaction.

Whether a button that clears the value is shown.

Whether the chevron button that opens the list is shown.

The accessible name of the chevron button, such as "Show cities". With it the button is a named tab stop; without it the button is for the pointer only: out of the tab order and hidden from assistive technology, since the input itself opens the list with the arrow keys.

Allows you to replace the component's HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.

A ref for the element the popup is anchored to. In multiple mode, pass it to ComboboxChips and to anchor of ComboboxContent, so the list opens below the whole field of chips instead of below the input.