Combobox
A searchable dropdown for filtering and selecting from a list of options.
Import
import { Combobox } from '@oztix/roadie-components/combobox'
Examples
Default
Emphasis
Sizes
States
Composition
With Field
Wrap Combobox in Field for consistent layout, labels, and
error handling. Field.Label's htmlFor wires directly to the Combobox input —
clicking the label focuses the search field.
With groups
With rich items
Use custom markup inside Combobox.Item to show metadata like a subtitle or
secondary label alongside the primary text.
Guidelines
When to use Combobox
Use Combobox when the user needs to search or filter a list, or when options are loaded from an API. The input lets users narrow results by typing — they usually know roughly what they're looking for.
- Venue or event search
- Assignee pickers (team members from an API)
- Tag or category selection with many options
- Any list over ~15 items
- Lists that load asynchronously
When to use Select instead
If the list is short, fixed, and fully known (under ~15 items), use Select. Users browse rather than search — no text input needed.
Combobox vs Autocomplete
If the user's typed value is always valid and suggestions just help, use Autocomplete. Think address fields or search bars.
| Question | Select | Combobox | Autocomplete |
|---|---|---|---|
| User types to filter? | No | Yes | Yes |
| Must pick from the list? | Yes | Yes | No — typed value is valid |
| Options from an API? | No | Yes | Yes |
| Custom/free-text value? | No | No | Yes |
| Primary interaction | Browse and pick | Search and pick | Type with suggestions |
| Typical list size | 2-15 items | 10-500+ items | Any |
Filtering
Pass the items prop to Combobox root for built-in client-side filtering. Use
Combobox.List with a render function child to template each filtered item:
Combobox.Empty only renders when the filtered list is empty. It requires the
items prop on root.
Async loading
For server-side search, update the items prop as results arrive. Use
Combobox.Status to announce state changes to screen readers:
<Combobox items={results} onInputValueChange={(value) => fetchResults(value)}>...<Combobox.Status>{isLoading ? 'Loading...' : `${results.length} results`}</Combobox.Status></Combobox>
Keyboard behaviour
- Arrow keys navigate the list
- Enter confirms the highlighted item
- Escape closes the popup
- Typing filters the list in real time
Accessibility
- Use a
<label>orCombobox.Labelto name the input. Combobox.ItemIndicatorshows a check on the selected item — include it for clarity.Combobox.Emptyannounces "no results" to screen readers automatically.Combobox.Statusis a live region — use it for async status like loading or result counts.
API reference
Combobox
Base UIFilter function used to match items vs input query.
Whether the component should ignore user interaction.
Defaults to false.
Identifies the field when a form is submitted.
The id of the component.
Whether list items are presented in a grid layout. When enabled, arrow keys navigate across rows and columns inferred from DOM rows.
Defaults to false.
Whether the list is rendered inline without using the popup.
Defaults to false.
The items to be displayed in the list. Can be either a flat array of items or an array of groups with items.
Whether the user should be unable to choose a different option from the popup.
Defaults to false.
Whether the user must choose a value before submitting a form.
Defaults to false.
Whether the popup is initially open. To render a controlled popup, use the `open` prop instead.
Defaults to false.
Whether the popup is currently open. Use when controlled.
Event handler called after any animations complete when the popup is opened or closed.
Whether the popup opens when clicking the input.
Defaults to true.
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](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/). 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>.
Defaults to true.
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.
A ref to the hidden input element.
Filtered items to display in the list. When provided, the list will use these items instead of filtering the `items` prop internally. Use when you want to control filtering logic externally with the `useFilter()` hook.
Whether the items are being externally virtualized.
Defaults to false.
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.
Defaults to false.
The maximum number of items to display in the list.
Defaults to -1.
The locale to use for string comparison. Defaults to the user's runtime locale.
Combobox.Clear
Base UIInherited from ComboboxClearProps
Whether the component should ignore user interaction.
Defaults to false.
Whether the component should remain mounted in the DOM when not visible.
Defaults to false.
Inherited from NativeButtonProps
Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (e.g. `<div>`).
Defaults to true.
Combobox.Collection
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.Empty
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.Group
Base UIInherited from ComboboxGroupProps
Items to be rendered within this group. When provided, child `Collection` components will use these items.
Combobox.GroupLabel
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.Input
Base UIInherited from ComboboxInputProps
Whether the component should ignore user interaction.
Defaults to false.
Combobox.InputGroup
Base UICombobox.Item
Base UIInherited from ComboboxItemProps
An optional click handler for the item when selected. It fires when clicking the item with the pointer, as well as when pressing `Enter` with the keyboard if the item is highlighted when the `Input` or `List` element has focus.
The index of the item in the list. Improves performance when specified by avoiding the need to calculate the index automatically from the DOM.
A unique value that identifies this item.
Defaults to null.
Whether the component should ignore user interaction.
Defaults to false.
Inherited from NativeButtonProps
Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (e.g. `<div>`).
Defaults to true.
Combobox.ItemIndicator
Base UIInherited from ComboboxItemIndicatorProps
Whether to keep the HTML element in the DOM when the item is not selected.
Defaults to false.
Combobox.Label
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.List
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.Popup
Base UIInherited from ComboboxPopupProps
Determines the element to focus when the popup is opened. - `false`: Do not move focus. - `true`: Move focus based on the default behavior (first tabbable element or popup). - `RefObject`: Move focus to the ref element. - `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, or `false`/`undefined` to do nothing.
Determines the element to focus when the popup is closed. - `false`: Do not move focus. - `true`: Move focus based on the default behavior (trigger or previously focused element). - `RefObject`: Move focus to the ref element. - `function`: Called with the interaction type (`mouse`, `touch`, `pen`, or `keyboard`). Return an element to focus, `true` to use the default behavior, or `false`/`undefined` to do nothing.
Combobox.Portal
Base UIInherited from ComboboxPortalProps
Whether to keep the portal mounted in the DOM while the popup is hidden.
Defaults to false.
Inherited from Props
A parent element to render the portal element into.
Combobox.Positioner
Base UIInherited from UseAnchorPositioningSharedParameters
An element to position the popup against. By default, the popup will be positioned against the trigger.
Determines which CSS `position` property to use.
Defaults to 'absolute'.
Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
Defaults to 'bottom'.
Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: - `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. - `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. - `data.side`: which side of the anchor element the positioner is aligned against. - `data.align`: how the positioner is aligned relative to the specified side. @example ```jsx <Positioner sideOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.height : anchor.width; }} /> ```
Defaults to 0.
How to align the popup relative to the specified side.
Defaults to 'center'.
Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment. The function takes a `data` object parameter with the following properties: - `data.anchor`: the dimensions of the anchor element with properties `width` and `height`. - `data.positioner`: the dimensions of the positioner element with properties `width` and `height`. - `data.side`: which side of the anchor element the positioner is aligned against. - `data.align`: how the positioner is aligned relative to the specified side. @example ```jsx <Positioner alignOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.width : anchor.height; }} /> ```
Defaults to 0.
An element or a rectangle that delimits the area that the popup is confined to.
Defaults to 'clipping-ancestors'.
Additional space to maintain from the edge of the collision boundary.
Defaults to 5.
Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
Defaults to false.
Minimum distance to maintain between the arrow and the edges of the popup. Use it to prevent the arrow element from hanging out of the rounded corners of a popup.
Defaults to 5.
Whether to disable the popup from tracking any layout shift of its positioning anchor.
Defaults to false.
Determines how to handle collisions when positioning the popup. `side` controls overflow on the preferred placement axis (`top`/`bottom` or `left`/`right`): - `'flip'`: keep the requested side when it fits; otherwise try the opposite side (`top` and `bottom`, or `left` and `right`). - `'shift'`: never change side; keep the requested side and move the popup within the clipping boundary so it stays visible. - `'none'`: do not correct side-axis overflow. `align` controls overflow on the alignment axis (`start`/`center`/`end`): - `'flip'`: keep side, but swap `start` and `end` when the requested alignment overflows. - `'shift'`: keep side and requested alignment, then nudge the popup along the alignment axis to fit. - `'none'`: do not correct alignment-axis overflow. `fallbackAxisSide` controls fallback behavior on the perpendicular axis when the preferred axis cannot fit: - `'start'`: allow perpendicular fallback and try the logical start side first (`top` before `bottom`, or `left` before `right` in LTR). - `'end'`: allow perpendicular fallback and try the logical end side first (`bottom` before `top`, or `right` before `left` in LTR). - `'none'`: do not fallback to the perpendicular axis. When `side` is `'shift'`, explicitly setting `align` only supports `'shift'` or `'none'`. If `align` is omitted, it defaults to `'flip'`. @example ```jsx <Positioner collisionAvoidance={{ side: 'shift', align: 'shift', fallbackAxisSide: 'none', }} /> ```
Combobox.Status
Base UINo additional props — forwards all standard HTML attributes to the underlying element.
Combobox.Trigger
Base UIInherited from ComboboxTriggerProps
Whether the component should ignore user interaction.
Defaults to false.
Inherited from NativeButtonProps
Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (e.g. `<div>`).
Defaults to true.