- Docs
- components
- ComboBox
ComboBox
A ComboBox combines a text input with a listbox, allowing users to filter a list of options to items matching a query.
A combo box can be built using the <datalist> HTML element, but this is very limited in functionality and difficult to style. ComboBox helps achieve accessible combo box and autocomplete components that can be styled as needed.
Installation
npx shadcn@latest add https://backchanel.com/default/comboboxComposed Components
A ComboBox uses the following components, which may also be used standalone or reused in other components.
Label
A label provides context for an element.
Input
An input allows a user to enter a plain text value with a keyboard.
Button
A button allows a user to perform an action, with mouse, touch, and keyboard interactions.
Popover
A popover is an overlay element positioned relative to a trigger.
ListBox
A listbox displays a list of options and allows a user to select one or more of them.
Reusable Wrapper - Example
If you will use a ComboBox in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.
The installed file includes a reusable wrapper JollyComboBox. This wrapper serves as an excellent starting point for use throughout your codebase.
The JollyComboBox component extends the props of React Aria ComboBox and adds:
| Prop | Type | Default | Description |
|---|---|---|---|
label | string | undefined | undefined | Label for the combobox |
description | string | null | undefined | undefined | Description text for the combobox |
errorMessage | string | ((validation: AriaValidationResult) => string) | undefined | undefined | Error message to display or function to generate it |
children | React.ReactNode | ((item: T) => React.ReactNode) | Required | Content for the combobox options |
You can copy this wrapper and create variations as needed for different use cases in your application. This approach promotes consistency while still allowing for flexibility in implementation.
Examples
Basic
Content
ComboBox follows the Collection Components API, accepting both static and dynamic collections. The examples above show static collections, which can be used when the full list of options is known ahead of time. Dynamic collections, as shown below, can be used when the options come from an external data source such as an API call, or update over time.
Links
Client Side Routing
The <ComboboxItem> component works with frameworks and client side routers like Next.js, Remix and React Router.
As with other React Aria components that support links, this works via the RouterProvider component at the root of your app.
See the client side routing guide to learn how to set this up.
Sections
Static
Dynamic
Text Slots
Menu Trigger Behavior
ComboBox supports three different menuTrigger prop values:
- input (default): ComboBox menu opens when the user edits the input text.
- focus: ComboBox menu opens when the user focuses the ComboBox input.
- manual: ComboBox menu only opens when the user presses the trigger button or uses the arrow keys.