Autocomplete

An input that suggests options as you type.

Search tags

import * as React from 'react';
import { Autocomplete } from '@base-ui-components/react/autocomplete';
import styles from './index.module.css';

export default function ExampleAutocomplete() {
  return (
    <Autocomplete.Root items={tags}>
      <label className={styles.Label}>
        Search tags
        <Autocomplete.Input placeholder="e.g. feature" className={styles.Input} />
      </label>

      <Autocomplete.Portal>
        <Autocomplete.Positioner className={styles.Positioner} sideOffset={4}>
          <Autocomplete.Popup className={styles.Popup}>
            <Autocomplete.Empty className={styles.Empty}>No tags found.</Autocomplete.Empty>
            <Autocomplete.List>
              {(tag: Tag) => (
                <Autocomplete.Item key={tag.id} className={styles.Item} value={tag}>
                  {tag.value}
                </Autocomplete.Item>
              )}
            </Autocomplete.List>
          </Autocomplete.Popup>
        </Autocomplete.Positioner>
      </Autocomplete.Portal>
    </Autocomplete.Root>
  );
}

interface Tag {
  id: string;
  value: string;
}

const tags: Tag[] = [
  { id: 't1', value: 'feature' },
  { id: 't2', value: 'fix' },
  { id: 't3', value: 'bug' },
  { id: 't4', value: 'docs' },
  { id: 't5', value: 'internal' },
  { id: 't6', value: 'mobile' },
  { id: 'c-accordion', value: 'component: accordion' },
  { id: 'c-alert-dialog', value: 'component: alert dialog' },
  { id: 'c-autocomplete', value: 'component: autocomplete' },
  { id: 'c-avatar', value: 'component: avatar' },
  { id: 'c-checkbox', value: 'component: checkbox' },
  { id: 'c-checkbox-group', value: 'component: checkbox group' },
  { id: 'c-collapsible', value: 'component: collapsible' },
  { id: 'c-combobox', value: 'component: combobox' },
  { id: 'c-context-menu', value: 'component: context menu' },
  { id: 'c-dialog', value: 'component: dialog' },
  { id: 'c-field', value: 'component: field' },
  { id: 'c-fieldset', value: 'component: fieldset' },
  { id: 'c-filterable-menu', value: 'component: filterable menu' },
  { id: 'c-form', value: 'component: form' },
  { id: 'c-input', value: 'component: input' },
  { id: 'c-menu', value: 'component: menu' },
  { id: 'c-menubar', value: 'component: menubar' },
  { id: 'c-meter', value: 'component: meter' },
  { id: 'c-navigation-menu', value: 'component: navigation menu' },
  { id: 'c-number-field', value: 'component: number field' },
  { id: 'c-popover', value: 'component: popover' },
  { id: 'c-preview-card', value: 'component: preview card' },
  { id: 'c-progress', value: 'component: progress' },
  { id: 'c-radio', value: 'component: radio' },
  { id: 'c-scroll-area', value: 'component: scroll area' },
  { id: 'c-select', value: 'component: select' },
  { id: 'c-separator', value: 'component: separator' },
  { id: 'c-slider', value: 'component: slider' },
  { id: 'c-switch', value: 'component: switch' },
  { id: 'c-tabs', value: 'component: tabs' },
  { id: 'c-toast', value: 'component: toast' },
  { id: 'c-toggle', value: 'component: toggle' },
  { id: 'c-toggle-group', value: 'component: toggle group' },
  { id: 'c-toolbar', value: 'component: toolbar' },
  { id: 'c-tooltip', value: 'component: tooltip' },
];

Usage guidelines

No selection state: Use Combobox instead of Autocomplete if the selection should be remembered and the input value cannot be custom. Unlike Combobox, Autocomplete’s input can contain free-form text, as its suggestions only optionally autocomplete the text.
Filterable command picker: The input can be used as a filter for command items that perform an action when clicked when rendered inside the popup.

Anatomy

Import the components and place them together:

Anatomy

import { Autocomplete } from '@base-ui-components/react/autocomplete';

<Autocomplete.Root>
  <Autocomplete.Input />
  <Autocomplete.Trigger />
  <Autocomplete.Icon />
  <Autocomplete.Clear />
  <Autocomplete.Value />

  <Autocomplete.Portal>
    <Autocomplete.Backdrop />
    <Autocomplete.Positioner>
      <Autocomplete.Popup>
        <Autocomplete.Arrow />

        <Autocomplete.Status />
        <Autocomplete.Empty />

        <Autocomplete.List>
          <Autocomplete.Row>
            <Autocomplete.Item />
          </Autocomplete.Row>

          <Autocomplete.Separator />

          <Autocomplete.Group>
            <Autocomplete.GroupLabel />
          </Autocomplete.Group>

          <Autocomplete.Collection />
        </Autocomplete.List>
      </Autocomplete.Popup>
    </Autocomplete.Positioner>
  </Autocomplete.Portal>
</Autocomplete.Root>

API reference

Root

Groups all parts of the autocomplete. Doesn't render its own HTML element.

name

string

Name: name
Description: Identifies the field when a form is submitted.
Type: string | undefined

defaultValue

Union

Name: defaultValue
Description: The uncontrolled input value of the autocomplete when it's initially rendered.

To render a controlled autocomplete, use the value prop instead.
Type: string | number | string[] | undefined

value

Union

Name: value
Description: The input value of the autocomplete. Use when controlled.
Type: string | number | string[] | undefined

onValueChange

function

Name: onValueChange
Description: Callback fired when the input value of the autocomplete changes.
Type: | (( value: string, eventDetails: Autocomplete.Root.ChangeEventDetails, ) => void) | undefined

defaultOpen

boolean

(default:

false

)

Name: defaultOpen
Description: Whether the popup is initially open.

To render a controlled popup, use the open prop instead.
Type: boolean | undefined
Default: false

open

boolean

Name: open
Description: Whether the popup is currently open.
Type: boolean | undefined

onOpenChange

function

Name: onOpenChange
Description: Event handler called when the popup is opened or closed.
Type: | (( open: boolean, eventDetails: Autocomplete.Root.ChangeEventDetails, ) => void) | undefined

actionsRef

RefObject<Autocomplete.Root.Actions>

Name: actionsRef
Description: A ref to imperative actions.

unmount: When specified, the autocomplete will not be unmounted when closed. Instead, the unmount function must be called to unmount the autocomplete manually. Useful when the autocomplete's animation is controlled by an external library.
Type: | React.RefObject<Autocomplete.Root.Actions> | undefined

alwaysSubmitOnEnter

boolean

(default:

false

)

Name: alwaysSubmitOnEnter
Description: Whether pressing Enter in the input should always allow forms to submit. By default, pressing Enter in the input will stop form submission if an item is highlighted.
Type: boolean | undefined
Default: false

autoHighlight

boolean

(default:

false

)

Name: autoHighlight
Description: Whether to automatically highlight the first item while filtering.
Type: boolean | undefined
Default: false

cols

number

(default:

1

)

Name: cols
Description: The maximum number of columns present when the items are rendered in grid layout. A value of more than 1 turns the listbox into a grid.
Type: number | undefined
Default: 1

filter

Union

Name: filter
Description: Filter function used to match items vs input query. The itemToStringLabel function is provided to help convert items to strings for comparison.
Type: | (( itemValue: Value, query: string, itemToStringLabel: | ((itemValue: Value) => string) | undefined, ) => boolean) | null | undefined

itemToStringValue

((itemValue: Value) => string)

Name: itemToStringValue
Description: When items' values are objects, converts its value to a string representation for display in the input.
Type: ((itemValue: Value) => string) | undefined

items

Group<Value>[] | Value[]

Name: items
Type: Group<Value>[] | Value[] | undefined

limit

number

(default:

-1

)

Name: limit
Description: The maximum number of items to display in the list.
Type: number | undefined
Default: -1

locale

Intl.LocalesArgument

Name: locale
Description: The locale to use for string comparison. Defaults to the user's runtime locale.
Type: Intl.LocalesArgument | undefined

Name: modal
Description: 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.
Type: boolean | undefined
Default: false

mode

Union

(default:

'list'

)

Name: mode
Description: Controls how the autocomplete behaves with respect to list filtering and inline autocompletion.

list (default): items are dynamically filtered based on the input value. The input value does not change based on the active item.

both: items are dynamically filtered based on the input value, which will temporarily change based on the active item (inline autocompletion).

inline: items are static (not filtered), and the input value will temporarily change based on the active item (inline autocompletion).

none: items are static (not filtered), and the input value will not change based on the active item.
Type: 'none' | 'list' | 'inline' | 'both' | undefined
Default: 'list'

onItemHighlighted

function

Name: onItemHighlighted
Description: Callback fired when the user navigates the list and highlights an item. Passes the item and the type of navigation or undefined when no item is highlighted.

keyboard: The item was highlighted via keyboard navigation.

pointer: The item was highlighted via pointer navigation.

none: The item was highlighted via programmatic navigation.
Type: | (( itemValue: Value | undefined, data: { type: 'none' | 'keyboard' | 'pointer' index: number }, ) => void) | undefined

onOpenChangeComplete

function

Name: onOpenChangeComplete
Description: Event handler called after any animations complete when the popup is opened or closed.
Type: ((open: boolean) => void) | undefined

openOnInputClick

boolean

(default:

true

)

Name: openOnInputClick
Description: Whether the popup opens when clicking the input.
Type: boolean | undefined
Default: true

virtualized

boolean

(default:

false

)

Name: virtualized
Description: Whether the items are being externally virtualized.
Type: boolean | undefined
Default: false

disabled

boolean

(default:

false

)

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

readOnly

boolean

(default:

false

)

Name: readOnly
Description: Whether the user should be unable to choose a different option from the popup.
Type: boolean | undefined
Default: false

required

boolean

(default:

false

)

Name: required
Description: Whether the user must choose a value before submitting a form.
Type: boolean | undefined
Default: false

inputRef

RefObject<HTMLInputElement>

Name: inputRef
Description: A ref to the hidden input element.
Type: React.RefObject<HTMLInputElement> | undefined

id

string

Name: id
Description: The id of the component.
Type: string | undefined

children

ReactNode

Name: children
Type: React.ReactNode | undefined

Value

The current value of the autocomplete. Doesn't render its own HTML element.

children

| ReactNode | ((value: string) => ReactNode)

Name: children
Type: React.ReactNode | ((value: string) => ReactNode)

Input

A text input to search for items in the list. Renders an <input> element.

disabled

boolean

(default:

false

)

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Input.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Input.State, ) => ReactElement)

data-popup-open

Present when the corresponding popup is open.

data-pressed

Present when the input is pressed.

data-disabled

Present when the component is disabled.

data-readonly

Present when the component is readonly.

data-required

Present when the component is required.

data-valid

Present when the component is in valid state (when wrapped in Field.Root).

data-invalid

Present when the component is in invalid state (when wrapped in Field.Root).

data-dirty

Present when the component's value has changed (when wrapped in Field.Root).

data-touched

Present when the component has been touched (when wrapped in Field.Root).

data-filled

Present when the component has a value (when wrapped in Field.Root).

data-focused

Present when the input is focused (when wrapped in Field.Root).

Attribute	Description
`data-popup-open`	Present when the corresponding popup is open.
`data-pressed`	Present when the input is pressed.
`data-disabled`	Present when the component is disabled.
`data-readonly`	Present when the component is readonly.
`data-required`	Present when the component is required.
`data-valid`	Present when the component is in valid state (when wrapped in Field.Root).
`data-invalid`	Present when the component is in invalid state (when wrapped in Field.Root).
`data-dirty`	Present when the component's value has changed (when wrapped in Field.Root).
`data-touched`	Present when the component has been touched (when wrapped in Field.Root).
`data-filled`	Present when the component has a value (when wrapped in Field.Root).
`data-focused`	Present when the input is focused (when wrapped in Field.Root).

Trigger

A button that opens the popup. Renders a <button> element.

nativeButton

boolean

(default:

true

)

Name: nativeButton
Description: 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>).
Type: boolean | undefined
Default: true

disabled

boolean

(default:

false

)

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Autocomplete.Trigger.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Trigger.State, ) => ReactElement)

data-popup-open

Present when the corresponding popup is open.

data-pressed

Present when the trigger is pressed.

data-disabled

Present when the component is disabled.

data-readonly

Present when the component is readonly.

data-required

Present when the component is required.

data-valid

Present when the component is in valid state (when wrapped in Field.Root).

data-invalid

Present when the component is in invalid state (when wrapped in Field.Root).

data-dirty

Present when the component's value has changed (when wrapped in Field.Root).

data-touched

Present when the component has been touched (when wrapped in Field.Root).

data-filled

Present when the component has a value (when wrapped in Field.Root).

data-focused

Present when the trigger is focused (when wrapped in Field.Root).

Attribute	Description
`data-popup-open`	Present when the corresponding popup is open.
`data-pressed`	Present when the trigger is pressed.
`data-disabled`	Present when the component is disabled.
`data-readonly`	Present when the component is readonly.
`data-required`	Present when the component is required.
`data-valid`	Present when the component is in valid state (when wrapped in Field.Root).
`data-invalid`	Present when the component is in invalid state (when wrapped in Field.Root).
`data-dirty`	Present when the component's value has changed (when wrapped in Field.Root).
`data-touched`	Present when the component has been touched (when wrapped in Field.Root).
`data-filled`	Present when the component has a value (when wrapped in Field.Root).
`data-focused`	Present when the trigger is focused (when wrapped in Field.Root).

Icon

An icon that indicates that the trigger button opens the popup. Renders a <span> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Icon.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Icon.State, ) => ReactElement)

Clear

Clears the value when clicked. Renders a <button> element.

nativeButton

boolean

(default:

true

)

Name: nativeButton
Description: 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>).
Type: boolean | undefined
Default: true

disabled

boolean

(default:

false

)

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Clear.State) => string)

keepMounted

boolean

(default:

false

)

Name: keepMounted
Description: Whether the component should remain mounted in the DOM when not visible.
Type: boolean | undefined
Default: false

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Clear.State, ) => ReactElement)

data-popup-open

Present when the corresponding popup is open.

data-disabled

Present when the button is disabled.

data-starting-style

Present when the button is animating in.

data-ending-style

Present when the button is animating out.

Attribute	Description
`data-popup-open`	Present when the corresponding popup is open.
`data-disabled`	Present when the button is disabled.
`data-starting-style`	Present when the button is animating in.
`data-ending-style`	Present when the button is animating out.

List

A list container for the items. Renders a <div> element.

children

| ReactNode | ((item: any, index: number) => ReactNode)

Name: children
Type: | React.ReactNode | ((item: any, index: number) => ReactNode)

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.List.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.List.State, ) => ReactElement)

Portal

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>.

container

Union

Name: container
Description: A parent element to render the portal element into.
Type: | HTMLElement | React.RefObject<HTMLElement | null> | null | undefined

children

ReactNode

Name: children
Type: React.ReactNode

keepMounted

boolean

(default:

false

)

Name: keepMounted
Description: Whether to keep the portal mounted in the DOM while the popup is hidden.
Type: boolean | undefined
Default: false

Backdrop

An overlay displayed beneath the popup. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Autocomplete.Backdrop.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Backdrop.State, ) => ReactElement)

data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-starting-style

Present when the popup is animating in.

data-ending-style

Present when the popup is animating out.

Attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-starting-style`	Present when the popup is animating in.
`data-ending-style`	Present when the popup is animating out.

Positioner

Positions the popup against the trigger. Renders a <div> element.

collisionAvoidance

CollisionAvoidance

Name: collisionAvoidance
Description: Determines how to handle collisions when positioning the popup.
Type: | { side?: 'none' | 'flip' align?: 'shift' | 'none' | 'flip' fallbackAxisSide?: 'none' | 'start' | 'end' } | { side?: 'shift' | 'none' align?: 'shift' | 'none' fallbackAxisSide?: 'none' | 'start' | 'end' } | undefined
Example: <Positioner collisionAvoidance={{ side: 'shift', align: 'shift', fallbackAxisSide: 'none', }} />

align

Align

(default:

'center'

)

Name: align
Description: How to align the popup relative to the specified side.
Type: 'center' | 'start' | 'end' | undefined
Default: 'center'

alignOffset

number | OffsetFunction

(default:

0

)

Name: alignOffset
Description: 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.
Type: | number | ((data: { side: Side align: Align anchor: { width: number; height: number } positioner: { width: number; height: number } }) => number) | undefined
Default: 0
Example: <Positioner alignOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.width : anchor.height; }} />

side

Side

(default:

'bottom'

)

Name: side
Description: Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
Type: | 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start' | undefined
Default: 'bottom'

sideOffset

number | OffsetFunction

(default:

0

)

Name: sideOffset
Description: 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.
Type: | number | ((data: { side: Side align: Align anchor: { width: number; height: number } positioner: { width: number; height: number } }) => number) | undefined
Default: 0
Example: <Positioner sideOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.height : anchor.width; }} />

arrowPadding

number

(default:

5

)

Name: arrowPadding
Description: 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.
Type: number | undefined
Default: 5

anchor

Union

Name: anchor
Description: An element to position the popup against. By default, the popup will be positioned against the trigger.
Type: | Element | React.RefObject<Element | null> | VirtualElement | (() => Element | VirtualElement | null) | null | undefined

collisionBoundary

Boundary

(default:

'clipping-ancestors'

)

Name: collisionBoundary
Description: An element or a rectangle that delimits the area that the popup is confined to.
Type: | Element | 'clipping-ancestors' | Element[] | Rect | undefined
Default: 'clipping-ancestors'

collisionPadding

Padding

(default:

5

)

Name: collisionPadding
Description: Additional space to maintain from the edge of the collision boundary.
Type: | { top?: number right?: number bottom?: number left?: number } | number | undefined
Default: 5

sticky

boolean

(default:

false

)

Name: sticky
Description: Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
Type: boolean | undefined
Default: false

positionMethod

'fixed' | 'absolute'

(default:

'absolute'

)

Name: positionMethod
Description: Determines which CSS position property to use.
Type: 'fixed' | 'absolute' | undefined
Default: 'absolute'

trackAnchor

boolean

(default:

true

)

Name: trackAnchor
Description: Whether the popup tracks any layout shift of its positioning anchor.
Type: boolean | undefined
Default: true

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Autocomplete.Positioner.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Positioner.State, ) => ReactElement)

data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-empty

Present when the items list is empty.

data-side

Indicates which side the popup is positioned relative to the trigger.

Attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-anchor-hidden`	Present when the anchor is hidden.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-empty`	Present when the items list is empty.
`data-side`	Indicates which side the popup is positioned relative to the trigger.

--anchor-height

The anchor's height.

--anchor-width

The anchor's width.

--available-height

The available height between the trigger and the edge of the viewport.

--available-width

The available width between the trigger and the edge of the viewport.

--transform-origin

The coordinates that this element is anchored to. Used for animations and transitions.

CSS Variable	Description
`--anchor-height`	The anchor's height.
`--anchor-width`	The anchor's width.
`--available-height`	The available height between the trigger and the edge of the viewport.
`--available-width`	The available width between the trigger and the edge of the viewport.
`--transform-origin`	The coordinates that this element is anchored to. Used for animations and transitions.

A container for the list. Renders a <div> element.

initialFocus

Union

Name: initialFocus
Description: 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.
Type: | boolean | React.RefObject<HTMLElement | null> | (( openType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined

finalFocus

Union

Name: finalFocus
Description: 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.
Type: | boolean | React.RefObject<HTMLElement | null> | (( closeType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Popup.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Popup.State, ) => ReactElement)

data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-align

Indicates how the popup is aligned relative to specified side.

data-empty

Present when the items list is empty.

data-instant

Present if animations should be instant.

data-side

Indicates which side the popup is positioned relative to the trigger.

data-starting-style

Present when the popup is animating in.

data-ending-style

Present when the popup is animating out.

Attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-empty`	Present when the items list is empty.
`data-instant`	Present if animations should be instant.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-starting-style`	Present when the popup is animating in.
`data-ending-style`	Present when the popup is animating out.

Arrow

Displays an element positioned against the anchor. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Arrow.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Arrow.State, ) => ReactElement)

data-open

Present when the popup is open.

data-closed

Present when the popup is closed.

data-uncentered

Present when the arrow is uncentered.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

Attribute	Description
`data-open`	Present when the popup is open.
`data-closed`	Present when the popup is closed.
`data-uncentered`	Present when the arrow is uncentered.
`data-anchor-hidden`	Present when the anchor is hidden.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.

Status

Displays a status message whose content changes are announced politely to screen readers. Useful for conveying the status of an asynchronously loaded list. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Status.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Status.State, ) => ReactElement)

Empty

Renders its children only when the list is empty. Requires the items prop on the root component. Announces changes politely to screen readers. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Empty.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Empty.State, ) => ReactElement)

Collection

Renders filtered list items. Doesn't render its own HTML element.

If rendering a flat list, pass a function child to the List component instead, which implicitly wraps it.

children^*

((item: any, index: number) => ReactNode)

Name: children
Type: (item: any, index: number) => ReactNode

Row

Displays a single row of items in a grid list. Specify cols on the root component to indicate the number of columns. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Row.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Row.State, ) => ReactElement)

Item

An individual item in the list. Renders a <div> element.

value

any

Name: value
Description: A unique value that identifies this item.
Type: any

index

number

Name: index
Description: The index of the item in the list. Improves performance when specified by avoiding the need to calculate the index automatically from the DOM.
Type: number | undefined

nativeButton

boolean

(default:

false

)

Name: nativeButton
Description: 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.
Type: boolean | undefined
Default: false

disabled

boolean

(default:

false

)

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

children

ReactNode

Name: children
Type: React.ReactNode

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Item.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Item.State, ) => ReactElement)

data-selected

Present when the item is selected.

data-highlighted

Present when the item is highlighted.

data-disabled

Present when the item is disabled.

Attribute	Description
`data-selected`	Present when the item is selected.
`data-highlighted`	Present when the item is highlighted.
`data-disabled`	Present when the item is disabled.

Group

Groups related items with the corresponding label. Renders a <div> element.

items

any[]

Name: items
Description: Items to be rendered within this group. When provided, child Collection components will use these items.
Type: any[] | undefined

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Autocomplete.Group.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.Group.State, ) => ReactElement)

GroupLabel

An accessible label that is automatically associated with its parent group. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Autocomplete.GroupLabel.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Autocomplete.GroupLabel.State, ) => ReactElement)

Separator

A separator element accessible to screen readers. Renders a <div> element.

orientation

Orientation

(default:

'horizontal'

)

Name: orientation
Description: The orientation of the separator.
Type: 'horizontal' | 'vertical' | undefined
Default: 'horizontal'

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: string | ((state: Separator.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | (( props: HTMLProps, state: Separator.State, ) => ReactElement)

Autocomplete

Usage guidelines

Anatomy

API reference

Root

Value

Input

Trigger

Icon

Clear

List

Portal

Backdrop

Positioner

Arrow

Status

Empty

Collection

Row

Item

Group

GroupLabel

Separator

Examples

Async search

Inline autocomplete

Grouped

Fuzzy matching

Limit results

Auto highlight

Grid layout

Virtualized