Skip to contents
1.0.0-beta.4GitHub

Autocomplete

An input that suggests options as you type.

View as Markdown

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

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

Event handler called when the input value of the autocomplete changes.

Type
| ((
    value: string,
    eventDetails: Autocomplete.Root.ChangeEventDetails,
  ) => void)
| undefined
defaultOpen

boolean

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. Use when controlled.

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

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

false

Name
autoHighlight
Description

Whether to automatically highlight the first item while filtering.

Type
boolean | undefined
Default

false

filter

Union

—
Name
filter
Description

Filter function used to match items vs input query.

Type
| ((
    itemValue: any,
    query: string,
    itemToString:
      | ((itemValue: any) => string)
      | undefined,
  ) => boolean)
| ((
    itemValue: ItemValue,
    query: string,
    itemToString:
      | ((itemValue: ItemValue) => string)
| null
| undefined
grid

boolean

false

Name
grid
Description

Whether list items are presented in a grid layout. When enabled, arrow keys navigate across rows and columns inferred from DOM rows.

Type
boolean | undefined
Default

false

itemToStringValue

Union

—
Name
itemToStringValue
Description

When the item values are objects (<Autocomplete.Item value={object}>), this function converts the object value to a string representation for both display in the input and form submission. If the shape of the object is { value, label }, the label will be used automatically without needing to specify this prop.

Type
| ((itemValue: any) => string)
| ((itemValue: ItemValue) => string)
| undefined
items

Union

—
Name
items
Description

The items to be displayed in the list. Can be either a flat array of items or an array of groups with items.

Type
{ items: any[] }[] | ItemValue[] | undefined
limit

number

-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
modal

boolean

false

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

'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'

onInputValueChange

function

—
Name
onInputValueChange
Description

Event handler called when the input value changes.

Type
| ((
    inputValue: string,
    eventDetails: Autocomplete.Root.ChangeEventDetails,
  ) => void)
| undefined
onItemHighlighted

function

—
Name
onItemHighlighted
Description

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.
  • 'none': the highlight changed programmatically.
Type
| ((
    highlightedValue: any | undefined,
    eventDetails: Autocomplete.Root.HighlightEventDetails,
  ) => void)
| ((
    highlightedValue: ItemValue | undefined,
    eventDetails: Autocomplete.Root.HighlightEventDetails,
  ) => 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

true

Name
openOnInputClick
Description

Whether the popup opens when clicking the input.

Type
boolean | undefined
Default

true

virtualized

boolean

false

Name
virtualized
Description

Whether the items are being externally virtualized.

Type
boolean | undefined
Default

false

disabled

boolean

false

Name
disabled
Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default

false

readOnly

boolean

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

false

Name
required
Description

Whether the user must choose a value before submitting a form.

Type
boolean | undefined
Default

false

inputRef

Ref<HTMLInputElement>

—
Name
inputRef
Description

A ref to the hidden input element.

Type
React.Ref<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

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).

Trigger

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

nativeButton

boolean

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

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).

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

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

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

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.

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>. Renders a <div> element.

container

Union

—
Name
container
Description

A parent element to render the portal element into.

Type
| HTMLElement
| ShadowRoot
| React.RefObject<HTMLElement | ShadowRoot | null>
| 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.Portal.State) => string)
keepMounted

boolean

false

Name
keepMounted
Description

Whether to keep the portal mounted in the DOM while the popup is hidden.

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.Portal.State,
  ) => ReactElement)

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.

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?: 'none' | 'shift' | 'flip'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| {
    side?: 'none' | 'shift'
    align?: 'none' | 'shift'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| undefined
Example
align

Align

'center'

Name
align
Description

How to align the popup relative to the specified side.

Type
'center' | 'start' | 'end' | undefined
Default

'center'

alignOffset

number | OffsetFunction

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
side

Side

'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

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
arrowPadding

number

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

'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

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

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'

'absolute'

Name
positionMethod
Description

Determines which CSS position property to use.

Type
'fixed' | 'absolute' | undefined
Default

'absolute'

trackAnchor

boolean

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.

--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.

Popup

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.

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.

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. Enable grid on the root component to turn the listbox into a grid. 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

null

Name
value
Description

A unique value that identifies this item.

Type
any
Default

null

onClick

function

—
Name
onClick
Description

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.

Type
React.MouseEventHandler<HTMLElement> | undefined
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

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

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.

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

'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)

useFilter

Matches items against a query using Intl.Collator for robust string matching. This hook is used when externally filtering items.

Input parameters

Accepts all Intl.CollatorOptions, plus the following option:

locale

Intl.LocalesArgument

—
Name
locale
Description

The locale to use for string comparison.

Type
Intl.LocalesArgument

Return value

contains

(itemValue: any, query: string) => boolean

—
Name
contains
Description

Returns whether the item matches the query anywhere.

Type
(itemValue: any, query: string) => boolean
startsWith

(itemValue: any, query: string) => boolean

—
Name
startsWith
Description

Returns whether the item starts with the query.

Type
(itemValue: any, query: string) => boolean
endsWith

(itemValue: any, query: string) => boolean

—
Name
endsWith
Description

Returns whether the item ends with the query.

Type
(itemValue: any, query: string) => boolean

TypeScript inference

Autocomplete infers the item type from the items prop passed to <Autocomplete.Root>. If using itemToStringValue, the value prop on the <Autocomplete.Item> must match the type of an item in the items array.

Examples

Async search

Load items asynchronously while typing and render custom status content.

Inline autocomplete

Autofill the input with the highlighted item while navigating with arrow keys using the mode prop. Accepts aria-autocomplete values list, both, inline, or none.

Grouped

Group related options together by passing an array of group objects to the items prop.

Fuzzy matching

Use fuzzy matching to find relevant results even when the query doesn’t exactly match the item text.

Limit results

Limit the number of visible items using the limit prop and guide users to refine their query using <Autocomplete.Status>.

Auto highlight

Automatically highlight the first matching option as the user types using the autoHighlight prop.

Grid layout

Display items in a grid layout, wrapping each row in <Autocomplete.Row> components.

Virtualized

Efficiently handle large datasets using a virtualization library like @tanstack/react-virtual.