Autocomplete
An input that suggests options as you type.
View as MarkdownUsage 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:
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
string
- Name
- Description
Identifies the field when a form is submitted.
- Type
string | undefined
defaultValue
Union
Union
- Name
- 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
Union
- Name
- Description
The input value of the autocomplete. Use when controlled.
- Type
string | number | string[] | undefined
onValueChange
function
function
- Name
- Description
Callback fired when the input value of the autocomplete changes.
- Type
| (( value: string, eventDetails: Autocomplete.Root.ChangeEventDetails, ) => void) | undefined
defaultOpen
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the popup is initially open.
To render a controlled popup, use the
open
prop instead.- Type
boolean | undefined
- Default
false
open
boolean
boolean
- Name
- Description
Whether the popup is currently open.
- Type
boolean | undefined
onOpenChange
function
function
- Name
- 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>
RefObject<Autocomplete.Root.Actions>
- Name
- Description
A ref to imperative actions.
unmount
: When specified, the autocomplete will not be unmounted when closed. Instead, theunmount
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
autoHighlight
boolean
(default: false
)
boolean
false
- Name
- Description
Whether to automatically highlight the first item when the popup opens.
- Type
boolean | undefined
- Default
false
cols
number
(default: 1
)
number
1
- Name
- 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
Union
- Name
- 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)
((itemValue: Value) => string)
- 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[]
Group<Value>[] | Value[]
- Name
- Type
Group<Value>[] | Value[] | undefined
limit
number
(default: -1
)
number
-1
- Name
- Description
The maximum number of items to display in the list.
- Type
number | undefined
- Default
-1
locale
Intl.LocalesArgument
Intl.LocalesArgument
- Name
- Description
The locale to use for string comparison. Defaults to the user's runtime locale.
- Type
Intl.LocalesArgument | undefined
modal
boolean
(default: false
)
boolean
false
- Name
- 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'
)
Union
'list'
- Name
- 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
function
- 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
function
- Description
Event handler called after any animations complete when the popup is opened or closed.
- Type
((open: boolean) => void) | undefined
openOnInputClick
boolean
(default: true
)
boolean
true
- Name
- Description
Whether the popup opens when clicking the input.
- Type
boolean | undefined
- Default
true
virtualized
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the items are being externally virtualized.
- Type
boolean | undefined
- Default
false
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
- Default
false
readOnly
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the user should be unable to choose a different option from the popup.
- Type
boolean | undefined
- Default
false
required
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the user must choose a value before submitting a form.
- Type
boolean | undefined
- Default
false
inputRef
RefObject<HTMLInputElement>
RefObject<HTMLInputElement>
- Name
- Description
A ref to the hidden input element.
- Type
React.RefObject<HTMLInputElement> | undefined
id
string
string
- Name
- Description
The id of the component.
- Type
string | undefined
children
ReactNode
ReactNode
- Name
- Type
React.ReactNode | undefined
Value
The current value of the autocomplete. Doesn't render its own HTML element.
children
| ReactNode
| ((value: string) => ReactNode)
| ReactNode
| ((value: string) => ReactNode)
- Name
- 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
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
- Default
false
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
(default: true
)
boolean
true
- Name
- Description
Whether the component renders a native
<button>
element when replacing it via therender
prop. Set tofalse
if the rendered element is not a button (e.g.<div>
).- Type
boolean | undefined
- Default
true
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
- Default
false
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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
)
boolean
true
- Name
- Description
Whether the component renders a native
<button>
element when replacing it via therender
prop. Set tofalse
if the rendered element is not a button (e.g.<div>
).- Type
boolean | undefined
- Default
true
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
- Default
false
className
string | function
string | function
- Name
- 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
)
boolean
false
- Name
- Description
Whether the component should remain mounted in the DOM when not visible.
- Type
boolean | undefined
- Default
false
render
ReactElement | function
ReactElement | function
- Name
- 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)
| ReactNode
| ((item: any, index: number) => ReactNode)
- Name
- Type
| React.ReactNode | ((item: any, index: number) => ReactNode)
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
Union
- Name
- Description
A parent element to render the portal element into.
- Type
| HTMLElement | React.RefObject<HTMLElement | null> | null | undefined
children
ReactNode
ReactNode
- Name
- Type
React.ReactNode
keepMounted
boolean
(default: false
)
boolean
false
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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
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'
)
Align
'center'
- Name
- Description
How to align the popup relative to the specified side.
- Type
'center' | 'start' | 'end' | undefined
- Default
'center'
alignOffset
number | OffsetFunction
(default: 0
)
number | OffsetFunction
0
- Name
- 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 propertieswidth
andheight
.data.positioner
: the dimensions of the positioner element with propertieswidth
andheight
.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'
)
Side
'bottom'
- Name
- 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
)
number | OffsetFunction
0
- Name
- 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 propertieswidth
andheight
.data.positioner
: the dimensions of the positioner element with propertieswidth
andheight
.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
)
number
5
- Name
- 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
Union
- Name
- 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'
)
Boundary
'clipping-ancestors'
- 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
)
Padding
5
- Name
- 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
)
boolean
false
- Name
- 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'
)
'fixed' | 'absolute'
'absolute'
- Name
- Description
Determines which CSS
position
property to use.- Type
'fixed' | 'absolute' | undefined
- Default
'absolute'
trackAnchor
boolean
(default: true
)
boolean
true
- Name
- Description
Whether the popup tracks any layout shift of its positioning anchor.
- Type
boolean | undefined
- Default
true
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
Union
- Name
- 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
, orkeyboard
). Return an element to focus,true
to use the default behavior, orfalse
/undefined
to do nothing.
- Type
| boolean | React.RefObject<HTMLElement | null> | (( openType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined
finalFocus
Union
Union
- Name
- 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
, orkeyboard
). Return an element to focus,true
to use the default behavior, orfalse
/undefined
to do nothing.
- Type
| boolean | React.RefObject<HTMLElement | null> | (( closeType: InteractionType, ) => boolean | void | HTMLElement | null) | undefined
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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)
((item: any, index: number) => ReactNode)
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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
any
- Name
- Description
A unique value that identifies this item.
- Type
any
index
number
number
- Name
- 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
)
boolean
false
- Name
- Description
Whether the component renders a native
<button>
element when replacing it via therender
prop. Set totrue
if the rendered element is a native button.- Type
boolean | undefined
- Default
false
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
- Default
false
children
ReactNode
ReactNode
- Name
- Type
React.ReactNode
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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[]
any[]
- Name
- Description
Items to be rendered within this group. When provided, child
Collection
components will use these items.- Type
any[] | undefined
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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
string | function
- Name
- 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
ReactElement | function
- Name
- 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'
)
Orientation
'horizontal'
- Name
- Description
The orientation of the separator.
- Type
'horizontal' | 'vertical' | undefined
- Default
'horizontal'
className
string | function
string | function
- Name
- 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
ReactElement | function
- Name
- 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)
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
.