Combobox

An input with a filterable list of suggestions, including multi-select chips.

import {
  Combobox,
  ComboboxContent,
  ComboboxEmpty,
  ComboboxInput,
  ComboboxItem,
  ComboboxList,
} from "@/components/ui/combobox";

const countries = [
  "Australia",
  "Brazil",
  "Canada",
  "Denmark",
  "France",
  "Germany",
  "India",
  "Ireland",
  "Japan",
  "Mexico",
  "Netherlands",
  "New Zealand",
  "Norway",
  "Portugal",
  "Singapore",
  "South Korea",
  "Spain",
  "Sweden",
  "United Kingdom",
  "United States",
];

export default function ComboboxBasic() {
  return (
    <Combobox items={countries}>
      <ComboboxInput
        placeholder="Select a country"
        aria-label="Country"
        showClear
        className="w-full max-w-xs"
      />
      <ComboboxContent>
        <ComboboxEmpty>No countries found.</ComboboxEmpty>
        <ComboboxList>
          {(item: string) => (
            <ComboboxItem key={item} value={item}>
              {item}
            </ComboboxItem>
          )}
        </ComboboxList>
      </ComboboxContent>
    </Combobox>
  );
}

Installation

Add the registryOnce per project
pnpm dlx shadcn@latest registry add @jarvis=https://ui.jarv.is/r/{name}.json
Add combobox
pnpm dlx shadcn@latest add @jarvis/combobox

Usage

import {
  Combobox,
  ComboboxContent,
  ComboboxEmpty,
  ComboboxInput,
  ComboboxItem,
  ComboboxList,
} from "@/components/ui/combobox";

const frameworks = ["Astro", "Next.js", "Remix", "SvelteKit", "TanStack Start"];

export function FrameworkCombobox() {
  return (
    <Combobox items={frameworks}>
      <ComboboxInput placeholder="Select a framework" aria-label="Framework" />
      <ComboboxContent>
        <ComboboxEmpty>No frameworks found.</ComboboxEmpty>
        <ComboboxList>
          {(item: string) => (
            <ComboboxItem key={item} value={item}>
              {item}
            </ComboboxItem>
          )}
        </ComboboxList>
      </ComboboxContent>
    </Combobox>
  );
}

Pass the options as items and render each one inside ComboboxList. ComboboxEmpty shows when nothing matches. Label the input with aria-label or a FieldLabel.

For a short list that doesn't need filtering, use a Select. When people may type a value that isn't an option, use an Autocomplete.

Composition

Combobox

Examples

Groups

Pass groups as items, each with its own items, and render them with ComboboxGroup and ComboboxCollection.

import {
  Combobox,
  ComboboxCollection,
  ComboboxContent,
  ComboboxEmpty,
  ComboboxGroup,
  ComboboxInput,
  ComboboxItem,
  ComboboxLabel,
  ComboboxList,
  ComboboxSeparator,
} from "@/components/ui/combobox";

const offices = [
  { value: "Americas", items: ["Brazil", "Canada", "Mexico", "United States"] },
  { value: "Europe", items: ["France", "Germany", "Ireland", "Spain", "Sweden"] },
  { value: "Asia Pacific", items: ["Australia", "India", "Japan", "Singapore"] },
];

export default function ComboboxGroups() {
  return (
    <Combobox items={offices}>
      <ComboboxInput
        placeholder="Select an office"
        aria-label="Office"
        className="w-full max-w-xs"
      />
      <ComboboxContent>
        <ComboboxEmpty>No offices found.</ComboboxEmpty>
        <ComboboxList>
          {(group: (typeof offices)[number], index: number) => (
            <ComboboxGroup key={group.value} items={group.items}>
              <ComboboxLabel>{group.value}</ComboboxLabel>
              <ComboboxCollection>
                {(item: string) => (
                  <ComboboxItem key={item} value={item}>
                    {item}
                  </ComboboxItem>
                )}
              </ComboboxCollection>
              {index < offices.length - 1 && <ComboboxSeparator />}
            </ComboboxGroup>
          )}
        </ComboboxList>
      </ComboboxContent>
    </Combobox>
  );
}

Use a ComboboxTrigger and put the ComboboxInput inside the popup. For object items, itemToStringLabel returns the text to search.

import { Avatar, AvatarFallback, AvatarImage } from "@/components/ui/avatar";
import { Button } from "@/components/ui/button";
import {
  Combobox,
  ComboboxContent,
  ComboboxEmpty,
  ComboboxInput,
  ComboboxItem,
  ComboboxList,
  ComboboxTrigger,
  ComboboxValue,
} from "@/components/ui/combobox";
import { people, type Person } from "@/examples/data";

export default function ComboboxSearchInPopup() {
  return (
    <Combobox
      items={people}
      defaultValue={people[0]}
      itemToStringLabel={(person: Person) => person.name}
    >
      <ComboboxTrigger
        render={
          <Button variant="secondary" className="w-full max-w-xs justify-between font-normal" />
        }
      >
        <ComboboxValue>{(person: Person | null) => person?.name ?? "Assign to…"}</ComboboxValue>
      </ComboboxTrigger>
      <ComboboxContent>
        <ComboboxInput showTrigger={false} placeholder="Search people" aria-label="Search people" />
        <ComboboxEmpty>No people found.</ComboboxEmpty>
        <ComboboxList>
          {(person: Person) => (
            <ComboboxItem key={person.value} value={person}>
              <Avatar size="sm">
                <AvatarImage src={person.image} alt="" />
                <AvatarFallback>{person.initials}</AvatarFallback>
              </Avatar>
              {person.name}
            </ComboboxItem>
          )}
        </ComboboxList>
      </ComboboxContent>
    </Combobox>
  );
}

Multiple

Set multiple to show the values as chips in ComboboxChips. Pass the ref from useComboboxAnchor to ComboboxContent as anchor so the popup lines up with the chips.

Design

Frontend

import {
  Combobox,
  ComboboxChip,
  ComboboxChips,
  ComboboxChipsInput,
  ComboboxContent,
  ComboboxEmpty,
  ComboboxItem,
  ComboboxList,
  ComboboxValue,
  useComboboxAnchor,
} from "@/components/ui/combobox";

const labels = [
  "Bug",
  "Design",
  "Documentation",
  "Frontend",
  "Backend",
  "Performance",
  "Accessibility",
];

export default function ComboboxMultiple() {
  const anchor = useComboboxAnchor();

  return (
    <Combobox items={labels} multiple autoHighlight defaultValue={["Design", "Frontend"]}>
      <ComboboxChips ref={anchor} className="w-full max-w-sm">
        <ComboboxValue>
          {(values: string[]) => (
            <>
              {values.map((value) => (
                <ComboboxChip key={value}>{value}</ComboboxChip>
              ))}
              <ComboboxChipsInput
                aria-label="Labels"
                placeholder={values.length > 0 ? "" : "Add labels"}
              />
            </>
          )}
        </ComboboxValue>
      </ComboboxChips>
      <ComboboxContent anchor={anchor}>
        <ComboboxEmpty>No labels found.</ComboboxEmpty>
        <ComboboxList>
          {(item: string) => (
            <ComboboxItem key={item} value={item}>
              {item}
            </ComboboxItem>
          )}
        </ComboboxList>
      </ComboboxContent>
    </Combobox>
  );
}

Props

ComboboxInput is an Input Group with open and clear buttons. ComboboxContent takes side, sideOffset, align, alignOffset and anchor.

Part	Extends
Combobox	Base UI's Combobox.Root
ComboboxValue	Base UI's Combobox.Value
ComboboxTrigger	Base UI's Combobox.Trigger
ComboboxInput	Base UI's Combobox.Input
ComboboxContent	Base UI's Combobox.Popup
ComboboxList	Base UI's Combobox.List
ComboboxItem	Base UI's Combobox.Item
ComboboxGroup	Base UI's Combobox.Group
ComboboxLabel	Base UI's Combobox.GroupLabel
ComboboxCollection	Base UI's Combobox.Collection
ComboboxEmpty	Base UI's Combobox.Empty
ComboboxSeparator	Base UI's Combobox.Separator
ComboboxChips	Base UI's Combobox.Chips
ComboboxChip	Base UI's Combobox.Chip
ComboboxChipsInput	Base UI's Combobox.Input

The tables leave out className, style and render. Parts built on Base UI take them as its styling and composition guides describe.

Combobox

Prop	Type	Default
`children`	`React.ReactNode`	—
`name` Identifies the field when a form is submitted.	`string`	—
`form` Identifies the form that owns the internal input. Useful when the combobox is rendered outside the form.	`string`	—
`id` The id of the component.	`string`	—
`required` Whether the user must choose a value before submitting a form.	`boolean`	`false`
`readOnly` Whether the user should be unable to choose a different option from the popup.	`boolean`	`false`
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`defaultOpen` Whether the popup is initially open. To render a controlled popup, use the `open` prop instead.	`boolean`	`false`
`open` Whether the popup is currently open. Use when controlled.	`boolean`	—
`onOpenChangeComplete` Event handler called after any animations complete when the popup is opened or closed.	`((open: boolean) => void)`	—
`openOnInputClick` Whether the popup opens when clicking the input.	`boolean`	`true`
`loopFocus` 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 ArrowDown again from the input, or the last item can be reached by pressing ArrowUp 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 ArrowDown, or when on the first element and the user presses ArrowUp.	`boolean`	`true`
`inputValue` The input value of the combobox. Use when controlled.	`string \| number \| readonly string[]`	—
`defaultInputValue` The uncontrolled input value when initially rendered. To render a controlled input, use the `inputValue` prop instead.	`string \| number \| readonly string[]`	—
`inputRef` A ref to the hidden input element.	`React.Ref<HTMLInputElement>`	—
`grid` Whether list items are presented in a grid layout. When enabled, arrow keys navigate across rows and columns inferred from DOM rows.	`boolean`	`false`
`items` 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.	`ComboboxItemCollection<unknown, unknown> \| readonly any[] \| readonly Group<any>[]`	—
`filteredItems` 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.	`readonly unknown[] \| readonly Group<unknown>[]`	—
`filter` 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.	`((item: unknown, query: string, itemToString?: ((item: unknown) => string) \| undefined) => boolean) \| null`	—
`virtualized` Whether the items are being externally virtualized.	`boolean`	`false`
`inline` 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.	`boolean`	`false`
`modal` 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.	`boolean`	`false`
`limit` The maximum number of items to display in the list.	`number`	`-1`
`locale` The locale to use for string comparison. Defaults to the user's runtime locale.	`Intl.LocalesArgument`	—
`multiple` Whether multiple items can be selected.	`boolean`	`false`
`autoComplete` Provides a hint to the browser for autofill.	`string`	—
`autoHighlight` Whether the first matching item is highlighted automatically while filtering.	`boolean`	`false`
`highlightItemOnHover` Whether moving the pointer over items should highlight them. Disabling this prop allows CSS `:hover` to be differentiated from the `:focus` (`data-highlighted`) state.	`boolean`	`true`
`itemToStringLabel` 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.	`((itemValue: unknown) => string)`	—
`itemToStringValue` 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.	`((itemValue: unknown) => string)`	—
`isItemEqualToValue` 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.	`((itemValue: unknown, value: unknown) => boolean)`	—
`defaultValue` The uncontrolled selected value of the combobox when it's initially rendered. To render a controlled combobox, use the `value` prop instead.	`unknown`	—
`actionsRef` 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.	`React.RefObject<AriaCombobox.Actions \| null>`	—
`onOpenChange` Event handler called when the popup is opened or closed.	`((open: boolean, eventDetails: Combobox.Root.OpenChangeEventDetails) => void)`	—
`onInputValueChange` Event handler called when the input value changes.	`((inputValue: string, eventDetails: Combobox.Root.ChangeEventDetails) => void)`	—
`onItemHighlighted` 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.	`((highlightedValue: unknown, eventDetails: Combobox.Root.HighlightEventDetails) => void)`	—
`value` The selected value of the combobox. Use when controlled.	`unknown`	—
`onValueChange` Event handler called when the selected value of the combobox changes.	`((value: unknown, eventDetails: Combobox.Root.ChangeEventDetails) => void)`	—

ComboboxValue

Prop	Type	Default
`children` Accepts a function that returns a `ReactNode` to format the selected value. Treat the value as read-only: in `multiple` mode it may be a shared frozen array when nothing is selected.	`((selectedValue: any) => React.ReactNode) \| React.ReactNode`	—
`placeholder` The placeholder value to display when no value is selected. This is overridden by `children` if specified, or by a null item's label in `items`.	`React.ReactNode`	—

ComboboxTrigger

Prop	Type	Default
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`nativeButton` 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 (for example, `<div>`).	`boolean`	`true`

ComboboxInput

Prop	Type	Default
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`showTrigger`	`boolean`	`true`
`showClear`	`boolean`	`false`
`size`	`"default" \| "lg"`	`"default"`

ComboboxContent

Prop	Type	Default
`initialFocus` 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.	`boolean \| React.RefObject<HTMLElement \| null> \| ((openType: InteractionType) => void \| boolean \| HTMLElement \| null)`	—
`finalFocus` 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.	`boolean \| React.RefObject<HTMLElement \| null> \| ((closeType: InteractionType) => void \| boolean \| HTMLElement \| null)`	—
`anchor` An element to position the popup against. By default, the popup will be positioned against the trigger.	`Element \| React.RefObject<Element \| null> \| VirtualElement \| (() => Element \| VirtualElement \| null) \| null`	—
`side` Which side of the anchor element to align the popup against. May automatically change to avoid collisions.	`"bottom" \| "inline-end" \| "inline-start" \| "left" \| "right" \| "top"`	`"bottom"`
`sideOffset` 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.	`number \| OffsetFunction`	`4`
`align` How to align the popup relative to the specified side.	`"center" \| "end" \| "start"`	`"start"`
`alignOffset` 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.	`number \| OffsetFunction`	`0`

ComboboxList

Prop	Type	Default
`children`	`((item: any, index: number) => React.ReactNode) \| React.ReactNode`	—

ComboboxItem

Prop	Type	Default
`children`	`React.ReactNode`	—
`onClick` 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.	`((event: BaseUIEvent<React.MouseEvent<HTMLDivElement, MouseEvent>>) => void)`	—
`index` The index of the item in the list. Improves performance when specified by avoiding the need to calculate the index automatically from the DOM.	`number`	—
`value` A unique value that identifies this item.	`any`	`null`
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`
`nativeButton` Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `true` if the rendered element is a native button.	`boolean`	`false`

ComboboxGroup

Prop	Type	Default
`items` Items to be rendered within this group. When provided, child `Collection` components will use these items.	`readonly any[]`	—

ComboboxCollection

Prop	Type	Default
`children`	`(item: any, index: number) => React.ReactNode`	—

ComboboxSeparator

Prop	Type	Default
`orientation` The orientation of the separator.	`"horizontal" \| "vertical"`	`'horizontal'`

ComboboxChip

Prop	Type	Default
`showRemove`	`boolean`	`true`

ComboboxChipsInput

Prop	Type	Default
`disabled` Whether the component should ignore user interaction.	`boolean`	`false`