Forms & inputExplore · Adapt · Compose

Combobox

Searchable select built from `Popover` + `Command` — API shaped like the shadcn combobox docs, without `@base-ui/react`. Use composable primitives or the `ComboboxSelect` preset for `{ label, value }[]`. Make the expected input clear before someone interacts, and keep the current value, help text and validation feedback connected. Explore the live examples, inspect their source and choose the composition that fits your interface before connecting it to your application's data.

The examples use @/components/kamod-ui/combobox in a Preact project. Follow the live result and its source together: compare supported options in the API reference, refine presentation with the component styles guide, and use shared theme tokens for consistent colors and surfaces. Preserve keyboard behavior and meaningful labels as you replace the sample content.

In this guide 7 sections
Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Installation

Import combobox primitives (and optionally ComboboxSelect) from @/components/kamod-ui/combobox.

pnpm add @kamod-ch/ui

The @/components/kamod-ui/… imports in these examples refer to local source files. Configure that alias when copying source, or use the corresponding exports from @kamod-ch/ui when installing the package. Connect the global theme CSS and Tailwind source detection before your first render.

Usage

Combobox supports single or multiple selection (value / onValueChange as string or string[]). liftedFilter shares the filter string between ComboboxInlineInput or ComboboxChipsInput and the list (Command stays mounted via forceMount on content). Set autoHighlight on the root (or ComboboxCommand) for first-match highlight plus ArrowUp/Down and Enter — works in ComboboxInput, ComboboxInlineInput, and ComboboxChipsInput via commandNavRef. showClear + ComboboxClear clears selection and filter. Multi-select: ComboboxChips + ComboboxChip + ComboboxChipsInput (implies liftedFilter). ComboboxSelect maps props to these patterns (liftedFilter, multiple, showClear, autoHighlight).

import { Combobox } from "@/components/kamod-ui/combobox";

Choose a complete composition from the examples below; required child components and props vary by pattern.

Component examples & variants

Explore Combobox in different contexts, from the starting pattern to the compositions below. Begin with Basic, then compare the examples that match your content, state and layout. These are working patterns to adapt, not a list of interchangeable variant values: check the API reference before using a prop or combining behaviors. Look at the surrounding labels, supporting text and spacing as well as the component itself.

Read the result and its implementation together. Use each showcase’s Code view to inspect imports and composition, or its Prompt view to prepare a setup or adaptation brief. Try the narrow preview and local theme controls before connecting real data, and use Reset to return an example to its initial state. Keep layout changes in class utilities where appropriate; follow the component styles guide for hierarchy and the theming guide for shared surfaces and colors. The accessibility notes explain what to preserve when making those changes.

Basic

String list, default selection, chevron on the trigger.

src/components/ComboboxExample.tsx
// combobox-doc.tsx — ComboboxBasicPreview

Preset: ComboboxSelect

Shortcut for options: { label, value }[] — replaces the legacy single-file combobox.

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Controlled

value + onValueChange; optional checkmark for the active row.

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Custom row content

Item + ItemTitle / ItemDescription inside ComboboxItem (shadcn custom items).

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Groups + separator

Grouped timezones with ComboboxGroup and ComboboxSeparator between sections.

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Invalid

aria-invalid on the trigger for error styling (pairs with Field invalid state).

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Disabled

disabled on Combobox disables the trigger.

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Auto-highlight + keyboard

autoHighlight on Combobox: first visible row is highlighted on filter; ArrowUp/Down moves; Enter activates (via Command).

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Clear button (preset)

ComboboxSelect with showClear — ComboboxClear resets selection (and filter when lifted).

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Inline input trigger (Base UI style)

ComboboxSelect with liftedFilter + autoHighlight: visible field is the filter; list opens below; optional showClear.

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width

Multi-select + chips

ComboboxSelect with multiple: chip row + ComboboxChipsInput; onValueChange receives string[].

Interactive previewTry it before you copy it
Live Preact example Local preview theme · Responsive styles follow the preview width
API reference

Props and data

Configure Combobox using the contracts below. Read the documented options alongside the source definitions to understand which values your application supplies and which details the component owns. Start with a prop or helper, then follow its type link to inspect the declaration without leaving the page.

Props, slots and variants for this component.

Type cards are extracted from this checkout’s TypeScript source at build time. Props inherited through HTMLAttributes, Omit or variant helpers remain references in those declarations; their fields are not flattened here. Match the reference to your installed version, and check a package’s exports before writing an import type. A type exported by a source file is not necessarily re-exported by @kamod-ch/ui.TypeScript

Component props

Read each option with its owning component. The
marker identifies required fields verified in that declaration. A ? means a field can be omitted; it does not promise a fallback value. Existing documented defaults remain alongside the descriptions. For callbacks, check the argument and return types before connecting your own state or services.

Combobox

Combobox component props and accepted values.

Combobox documented props
Prop / typeDescription
Combobox items
readonly unknown[]ComboboxProps

Documented Combobox items option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented default[]

Combobox multiple / liftedFilter / autoHighlight / showClear
booleanComboboxProps

Documented Combobox multiple / liftedFilter / autoHighlight / showClear option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented defaultfalse

Combobox value / defaultValue / onValueChange
string | string[]ComboboxProps

Documented Combobox value / defaultValue / onValueChange option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented default—

ComboboxItem item
unknown (row payload)ComboboxProps

Documented ComboboxItem item option for Combobox. Check its type alongside the usage examples before supplying a value.

Usage requirementRequired

ComboboxList children
(item, index) => vnodeComboboxProps

Documented ComboboxList children option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented default—

ComboboxSelect
liftedFilter, multiple, showClear, autoHighlightComboboxProps

Documented ComboboxSelect option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented default—

Command autoHighlight
booleanComboboxProps

Documented Command autoHighlight option for Combobox. Check its type alongside the usage examples before supplying a value.

Documented defaultfalse

Data type reference

Expand a card to inspect and copy the exact declaration. The code header identifies its repository file; follow imported or inherited types in the implementation source when you need the complete dependency chain. Required-field summaries cover fields declared directly in that type. Source-only helpers and inferred schema outputs describe the local implementation, not additional props you can pass to every component.

ComboboxChipProps
Exported source declaration from ComboboxChip.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
itemKey
ComboboxChipsProps
Exported source declaration from ComboboxChips.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
ComboboxChipsInputProps
Exported source declaration from ComboboxChipsInput.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
ComboboxClearProps
Exported source declaration from ComboboxClear.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
ComboboxInlineInputProps
Exported source declaration from ComboboxInlineInput.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
ComboboxItemProps
Exported source declaration from ComboboxItem.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
item
ComboboxListProps
Exported source declaration from ComboboxList.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
children
ComboboxOption
Exported source declaration from ComboboxSelect.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
label, value
ComboboxSelectProps
Exported source declaration from ComboboxSelect.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
options
ComboboxValueProps
Exported source declaration from ComboboxValue.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
ComboboxCommandNav
Exported source declaration from combobox-context.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
moveHighlight, activateHighlighted
ComboboxContextValue
Exported source declaration from combobox-context.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.
Required fields
items, leafItems, itemToString, itemKey, selectedKeys, selectedKey, multiple, isSelected, selectByItem, toggleByItem, removeKey, clearSelection, placeholder, disabled, liftedFilter, filterQuery, hasVisibleItems, autoHighlight, showClear, closeOnSelect, comboboxListRef, commandNavRef
ComboboxProps
Exported source declaration from combobox-context.tsx. Referenced types retain their original names; inspect that file for imports and supporting definitions.

Accessibility

Build the complete interaction, including the parts outside Combobox. The notes below distinguish the current implementation from the labels, content and behavior your application supplies. Start with the live preview, check the props and data reference, and test the finished composition with real content rather than assuming that an unchanged visual example covers every use case.

Built-in behavior and defaults

Combobox composes selection, search and popover/command pieces. Arrow highlighting is controlled by autoHighlight, which defaults to false in the convenience composition. Do not infer a complete ARIA combobox contract solely from the component name.

Labels and relationships

Label the trigger and any separate search input according to their jobs. A filter placeholder is a hint, not a persistent label. Selected chips need identifiable removal actions; the default short Remove name may need extra context in a multi-selection interface.

Keyboard and focus

With autoHighlight enabled, supported input handlers use Up/Down to move the highlight and Enter to activate it. Check the exact composition you use, including empty results, clearing, closing and focus return; visual highlighting alone does not guarantee that active results are announced.

States and integration details

Keep loading, no matches and no selection as separate states. Verify the rendered input/list relationship and screen-reader output before adopting the control for a critical workflow. Do not add combobox roles without the associated focus and state behavior.

Verify the complete interaction

Check behavior as well as markup. Work through these scenarios in the application where the component will be used. Automated checks can help find structural problems; also review the reading experience with a screen reader, keyboard focus and the actual feedback from your application.

  1. Search with the keyboard, select a result, reopen and clear the selection without losing the field label.
  2. Remove a chip and verify focus goes to a surviving control with a meaningful name.
  3. Test no matches, asynchronous results and disabled choices with your target screen reader.

Recheck the result after changing theme tokens, translations or class overrides. Include text enlargement, narrow layouts and reduced-motion settings where animation is present. Inspect the component source when a behavior differs from your expectation; a role or state attribute does not implement keyboard interaction by itself.

For background, read the WAI-ARIA authoring guidance and keyboard interface guidance. These explain the patterns; verify browser and assistive-technology behavior for the implementation and audience you actually support.

Build it into your interface

Use the Combobox examples as a starting point, then review the behavior in the context of your own screen. Layout, state and content should work together.

Connect the behavior

Choose where the value lives before wiring up validation. Use the documented change callback, preserve the field name when submitting a native form, and associate help or error text with the control. A placeholder supplements a label; it does not replace one.

Copy the composition, then connect its intent. Replace sample records and callbacks with your own data flow. For options such as value, defaultValue, open or onChange, use only those documented in this component's API; different components expose different contracts.

Give each piece of state one owner. Keep a temporary selection inside the interface when nothing else needs it; lift shared values into a parent when other controls depend on them. Read the prop reference before combining controlled values with defaults. A default normally initializes a control; it is not a substitute for updating its current value.

Connect requests in an event handler or your application’s data layer, never as a side effect of rendering. Keep pending, completed and failed outcomes distinct, preserve useful input after an error, and offer a clear recovery action. If the integration subscribes to an external source, remove that subscription when its owner unmounts; cancel or ignore obsolete requests so an earlier response cannot replace newer results.

Start with the live preview, then exercise the same interaction with your actual data. The type definitions describe accepted values; they do not implement persistence, navigation or server-side validation for you. Keep those responsibilities in the application that composes the UI.

Refine the presentation

Let a parent own the surrounding spacing. Keep related elements together with gap and use semantic surface/foreground pairs so the composition follows the active theme. The wrapper below changes the surrounding layout without assuming extra props on Combobox.

src/components/ExampleSurface.tsx
import type { ComponentChildren } from "preact";

export function ExampleSurface({ children }: { children: ComponentChildren }) {
  return (
    <div class="grid min-w-0 gap-4 rounded-lg border border-border bg-card p-4 text-card-foreground sm:p-6">
      {children}
    </div>
  );
}

Put the chosen example inside ExampleSurface, then refine supported variants and sizes using the API above. For application-wide changes, adjust theme tokens instead of repeating fixed colors. See Component styles for hierarchy, density and focus treatments.

Review the complete interaction

  • Try an empty value, a valid value and a rejected value; keep the correction visible beside the field.
  • Navigate using only the keyboard and verify the label identifies the focused control.
  • Check disabled and read-only behavior separately where supported; they communicate different intentions.

The preview's narrow control changes its container width. Also resize the browser when checking viewport-based Tailwind utilities such as sm: and md:, and test overlays in the full page where their portals render.

Compose a complete interface

Combobox is one part of the interaction. Choose companion components for the information or actions that still need a place on the screen. The references below are suggestions to compose deliberately, not extra dependencies you must add to every example.

Keep one source of truth for the operation and let each component communicate a different part of it. For example, waiting, no results and failure need different explanations. Avoid showing contradictory states together, and keep recovery actions close to the message that explains them.

Start with the smallest composition that explains the task. Browse the component library for individual controls or the block collections for complete layouts. Reuse shared theme tokens so these pieces feel consistent in light and dark mode.

Sources & design references

Follow Combobox from its implementation to the ideas behind your own composition. Start with the local API, explore a visual direction, then bring the result back to your app’s shared styles.

Implementation · Preact

Kamod UI implementation

Start with the code that powers this page. The Combobox source in Kamod UI is the implementation reference. Use the installation guide for setup and the API reference for supported props, composition and events before adapting an example.

Source locationpackages/core/src/components/combobox

Compare imports, default values and state handling with the example you chose. The repository’s main branch can be ahead of your installed version; check your package.json and lockfile when an API differs. Retain applicable license notices when reusing source.

Visual reference · Independently maintained

Explore the visual possibilities

Browse the Combobox collection on Shadcnblocks to compare hierarchy, density and composition. Look at how labels, supporting text and surrounding space work together, then choose the details that help your own content read clearly.

Reference credit: Shadcnblocks. These independently maintained React examples are visual references; this link does not claim they authored Kamod’s Preact implementation. Check the original example’s license before reusing its code or assets, and use this page’s API when building the Kamod version.

Bring it back to your app

A reference becomes useful when it fits your real content. Work through these decisions in order:

  1. Keep the behavior grounded. Start with the interactive examples, then connect your data and callbacks using the integration guidance. Preserve labels, keyboard access and disabled states as you change the presentation.
  2. Make the styling repeatable. Use the styles guide for local class adjustments and theming documentation for shared color decisions. Keep semantic surface and foreground pairs together in both light and dark mode.
  3. Check the complete screen. See how components combine in the block collections, then try long labels, loading states and narrow layouts in your own composition. The Theme Toggle guide helps you expose a scheme switch in the finished interface.