Typeahead

Single-select combobox that filters options as the user types. Built on the shared Combobox primitive with label, description, error, clear button, and listbox wiring included.

Examples

Default

Fruit

import { Typeahead } from '@var-ui/react';

<Typeahead
  label="Fruit"
  options={[
    { id: 'apple', label: 'Apple' },
    { id: 'plum', label: 'Plum' },
    { id: 'orange', label: 'Orange' },
  ]}
/>

Description and validation

Pass description for helper text and errorMessage to show an error state.

Fruit

Start typing to filter the list.

import { Typeahead } from '@var-ui/react';

<Typeahead
  label="Fruit"
  description="Start typing to filter the list."
  errorMessage="Choose a fruit to continue."
  options={[
    { id: 'apple', label: 'Apple' },
    { id: 'plum', label: 'Plum' },
    { id: 'orange', label: 'Orange' },
  ]}
/>

Props

Accessibility

Built on React Aria Components where applicable.

Props

Prop	Type	Default	Description
`options`	`ComboboxOption[]`	—	Options filtered as the user types.
`className`	`string \| (((values: ComboBoxRenderProps & { defaultClassName: string \| undefined; }) => string) & string) \| undefined`	`'react-aria-ComboBox'`	The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
`description`	`string \| undefined`	—	Helper text shown below the control when there is no error.
`errorMessage`	`string \| undefined`	—	Validation message; when set, the field is shown in an error state.
`label`	`string \| undefined`	—	Field label rendered above the input.
`placeholder`	`string \| undefined`	`'Search…'`	Placeholder text shown when the input is empty.

React Aria props

Prop	Type	Default	Description
`allowsEmptyCollection`	`boolean \| undefined`	—	Whether the combo box allows the menu to be open when the collection is empty.
`aria-describedby`	`string \| undefined`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string \| undefined`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-label`	`string \| undefined`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string \| undefined`	—	Identifies the element (or elements) that labels the current element.
`autoFocus`	`boolean \| undefined`	—	Whether the element should receive focus on render.
`defaultFilter`	`((textValue: string, inputValue: string) => boolean) \| undefined`	—	The filter function used to determine if a option should be included in the combo box list.
`defaultValue`	`Key \| null \| undefined`	—	The default value (uncontrolled).
`dir`	`string \| undefined`	—	—
`disabledKeys`	`Iterable<Key> \| undefined`	—	The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.
`form`	`string \| undefined`	—	The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
`formValue`	`"text" \| "key" \| undefined`	`'key'`	Whether the text or key of the selected item is submitted as part of an HTML form. When `allowsCustomValue` is `true`, this option does not apply and the text is always submitted.
`hidden`	`boolean \| undefined`	—	—
`id`	`string \| undefined`	—	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`inert`	`boolean \| undefined`	—	—
`isDisabled`	`boolean \| undefined`	—	Whether the input is disabled.
`isInvalid`	`boolean \| undefined`	—	Whether the input value is invalid.
`isReadOnly`	`boolean \| undefined`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean \| undefined`	—	Whether user input is required on the input before form submission.
`lang`	`string \| undefined`	—	—
`name`	`string \| undefined`	—	The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
`onAnimationEnd`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationEndCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIteration`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIterationCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStart`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStartCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onBlur`	`((e: FocusEvent<HTMLInputElement, Element>) => void) \| undefined`	—	Handler that is called when the element loses focus.
`onChange`	`((value: Key \| null) => void) \| undefined`	—	Handler that is called when the value changes.
`onClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenu`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenuCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onFocus`	`((e: FocusEvent<HTMLInputElement, Element>) => void) \| undefined`	—	Handler that is called when the element receives focus.
`onFocusChange`	`((isFocused: boolean) => void) \| undefined`	—	Handler that is called when the element's focus status changes.
`onGotPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onGotPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onKeyDown`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is pressed.
`onKeyUp`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is released.
`onLostPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onLostPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDown`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDownCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseEnter`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseLeave`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMove`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMoveCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOut`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOutCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOver`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOverCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUp`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUpCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancel`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancelCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDown`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDownCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerEnter`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerLeave`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMove`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMoveCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOut`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOutCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOver`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOverCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUp`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUpCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onScroll`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onScrollCapture`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancel`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancelCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEnd`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEndCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMove`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMoveCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStart`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStartCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancel`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancelCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEnd`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEndCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRun`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRunCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStart`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStartCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheel`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheelCapture`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`render`	`DOMRenderFunction<"div", ComboBoxRenderProps> \| undefined`	—	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
`shouldFocusWrap`	`boolean \| undefined`	—	Whether keyboard navigation is circular.
`slot`	`string \| null \| undefined`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
`style`	`StyleOrFunction<ComboBoxRenderProps> \| undefined`	—	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
`translate`	`"yes" \| "no" \| undefined`	—	—
`validate`	`((value: ComboBoxValidationValue<"single">) => true \| ValidationError \| null \| undefined) \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`validationBehavior`	`"native" \| "aria" \| undefined`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`value`	`Key \| null \| undefined`	—	The current value (controlled).

DOM props (12)

Prop	Type	Default	Description
`allowsCustomValue`	`boolean \| undefined`	—	Whether the ComboBox allows a non-item matching input value to be set.
`defaultInputValue`	`string \| undefined`	—	The default value of the ComboBox input (uncontrolled).
`defaultItems`	`Iterable<ComboboxOption> \| undefined`	—	The list of ComboBox items (uncontrolled).
`defaultSelectedKey`	`Key \| null \| undefined`	—	The initial selected key in the collection (uncontrolled).
`inputValue`	`string \| undefined`	—	The value of the ComboBox input (controlled).
`items`	`Iterable<ComboboxOption> \| undefined`	—	The list of ComboBox items (controlled).
`menuTrigger`	`MenuTriggerAction \| undefined`	`'input'`	The interaction required to display the ComboBox menu.
`onInputChange`	`((value: string) => void) \| undefined`	—	Handler that is called when the ComboBox input value changes.
`onOpenChange`	`((isOpen: boolean, menuTrigger?: MenuTriggerAction \| undefined) => void) \| undefined`	—	Method that is called when the open state of the menu changes. Returns the new open state and the action that caused the opening of the menu.
`onSelectionChange`	`((key: Key \| null) => void) \| undefined`	—	Handler that is called when the selection changes.
`selectedKey`	`Key \| null \| undefined`	—	The currently selected key in the collection (controlled).
`selectionMode`	`"single" \| undefined`	`'single'`	Whether single or multiple selection is enabled.

Theme this component via createDesignTheme({ components: { typeahead: … } }). See Customize for the full override API.

Public classes and data attributes from @var-ui/core typeahead().

root

Name	Example	Description
`class`	`var-ui-typeahead`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

label

Name	Example	Description
`class`	`var-ui-typeahead__label`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

description

Name	Example	Description
`class`	`var-ui-typeahead__description`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

error

Name	Example	Description
`class`	`var-ui-typeahead__error`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

inputWrapper

Name	Example	Description
`class`	`var-ui-typeahead__inputWrapper`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

input

Name	Example	Description
`class`	`var-ui-typeahead__input`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

clearButton

Name	Example	Description
`class`	`var-ui-typeahead__clearButton`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

Name	Example	Description
`class`	`var-ui-typeahead__popover`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

listbox

Name	Example	Description
`class`	`var-ui-typeahead__listbox`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

item

Name	Example	Description
`class`	`var-ui-typeahead__item`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

Apply via `recipeProps(recipe(…))` or copy the class / data attributes onto your markup.

Typeahead

Examples

Default

Description and validation

Props

Accessibility

Props

React Aria props

root

label

description

error

inputWrapper

input

clearButton

popover

listbox

item