XiodUI
HomeDocs
OverviewComponentsStyling & CustomizationChangelog

Components

  • Accordion
  • Agent Steps
  • Alert
  • Alert Dialog
  • Aspect Ratio
  • Autocomplete
  • Avatar
  • Badge
  • Breadcrumb
  • Button
  • Button Group
  • Button Split
  • Calendar
  • Card
  • Carousel
  • Checkbox
  • Circular Progress
  • Collapsible
  • Color Picker
  • Combobox
  • Command
  • Context Menu
  • Copy To Clipboard
  • Corner Badge
  • Dashboard Grid
  • Date Picker
  • Dialog
  • Dot Matrix
  • Draggable
    Updated
  • Drawer
  • Empty
  • Field
  • Fieldset
  • File Upload
    Updated
  • Form
  • Frame
  • Gauge
  • Grid
  • Group
  • Input
  • Input Group
  • Input OTP
  • Input Payment
  • Input Phone
    Updated
  • Input Sensitive
  • Kbd
  • Kinetic Click
  • Label
  • List Box
    Updated
  • Loader
  • Marker
  • Menu
  • Menubar
  • Message
  • Meter
  • Morphic Toast
  • Navigation Menu
  • Number Field
  • Option Picker
  • Orb
  • Pagination
  • Popover
  • Preview Card
    Updated
  • Progress
  • Radio
  • Resizable
  • Ruler Picker
  • Scroll Area
  • Scroll Bar
  • Select
  • Separator
  • Sidebar
  • Skeleton
  • Slider
  • Sortable
  • Switch
  • Table
  • Tabs
  • Text
  • Textarea
  • Timeline
  • Toast
  • Toggle
  • Toggle Group
  • Toolbar
  • Tooltip
  • Waveform
  • Wheel Picker

Loading...

Preview Skeleton

Installation Skeleton

Usage Skeleton

API Reference Skeleton

Sponsors

Support the development of XiodUI and help us build the best component library on Earth.

+++
Sponsor on GitHub

Autocomplete

Previous: Aspect RatioNext: Avatar

A text input that suggests matching options as the user types.

Preview

Loading Preview...

Installation

bun add xiod-ui

Usage

Imports

1import {2  Autocomplete,3  AutocompleteClear,4  AutocompleteCollection,5  AutocompleteEmpty,6  AutocompleteGroup,7  AutocompleteGroupLabel,8  AutocompleteInput,9  AutocompleteItem,10  AutocompleteList,11  AutocompletePopup,12  AutocompleteRow,13  AutocompleteSeparator,14  AutocompleteStatus,15  AutocompleteTrigger,16  AutocompleteValue17} from "xiod-ui/autocomplete";

Anatomy

1<Autocomplete>2  <AutocompleteInput />3  <AutocompletePopup>4    <AutocompleteEmpty />5    <AutocompleteList>6      <AutocompleteItem />7    </AutocompleteList>8  </AutocompletePopup>9</Autocomplete>

API Reference

Detailed documentation of properties and options.

Autocomplete

PropTypeDefaultDescription
itemsReq
Items
–

The items to be displayed in the list. Can be either a flat array of items or an array of groups with items. Nullish entries are not supported: remove them from the data before passing it.

actionsRef
RefObject<AutocompleteRootActions | null>
–
Aspect RatioAvatar

A ref to imperative actions.

  • unmount: Ends the closing phase of the autocomplete after an externally controlled closing animation finishes.

Call preventUnmountOnClose() in onOpenChange first, otherwise the autocomplete completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.

  • close: Closes the autocomplete imperatively when called.
autoHighlight
boolean|"always"
false

Whether the first matching item is highlighted automatically.

  • true: highlight after the user types and keep the highlight while the query changes.
  • 'always': always highlight the first item.
children
ReactNode
–

The content of the component.

defaultOpen
boolean
false

Whether the popup is initially open.

To render a controlled popup, use the open prop instead.

defaultValue
string | number | readonly string[]
–

The uncontrolled input value of the autocomplete when it's initially rendered.

To render a controlled autocomplete, use the value prop instead.

disabled
boolean
false

Whether the component should ignore user interaction.

filter
AriaCombobox.Props<ItemValue, 'none'>['filter']
–

Filter function used to match items against the input query.

filteredItems
readonly ItemValue[] | readonly Group<ItemValue>[]
–

Filtered items to display in the list. When provided, the list uses these items instead of filtering the items prop internally. When items is also provided, this array must preserve its flat or grouped structure. Nullish entries are not supported, as in items. Use when you want to control filtering logic externally with the useFilter() hook.

form
string
–

Identifies the form that owns the internal input. Useful when the autocomplete is rendered outside the form.

grid
boolean
false

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

highlightItemOnHover
boolean
true

Whether moving the pointer over items should highlight them. Disabling this prop allows CSS :hover to be differentiated from the :focus (data-highlighted) state.

id
string
–

The id of the component.

inline
boolean
false

Whether the list is rendered inline without using the component's own popup.

Specify open unconditionally in conjunction with this prop so the list is considered visible: <Autocomplete.Root inline open>

inputRef
Ref<HTMLInputElement>
–

A ref to the hidden input element.

itemToStringValue
((itemValue: Items[number]["items"][number]) => string)
–

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.

keepHighlight
boolean
false

Whether the highlighted item should be preserved when the pointer leaves the list.

limit
number
-1

The maximum number of items to display in the list.

locale
LocalesArgument
–

The locale to use for string comparison. Defaults to the user's runtime locale.

loopFocus
boolean
true

Whether to loop keyboard focus back to the input when the end of the list is reached while using the arrow keys. The first item can then be reached by pressing <kbd>ArrowDown</kbd> again from the input, or the last item can be reached by pressing <kbd>ArrowUp</kbd> from the input. The input is always included in the focus loop per [ARIA Authoring Practices](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/). When disabled, focus does not move when on the last element and the user presses <kbd>ArrowDown</kbd>, or when on the first element and the user presses <kbd>ArrowUp</kbd>.

modal
boolean
false

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.

On touch devices, a true modal blocks outside taps but leaves the page scrollable unless the popup spans nearly the full viewport width, matching native iOS behavior.

mode
"none"|"inline"|"list"|"both"
'list'

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.
name
string
–

Identifies the field when a form is submitted.

onItemHighlighted
((highlightedValue: ItemValue, eventDetails: AutocompleteRootHighlightEventDetails) => void)
–

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. The event may be a MouseEvent rather than a PointerEvent.
  • 'none': the highlight changed for another reason, such as typing, autoHighlight, the item list changing, or the popup opening or closing.
onOpenChange
((open: boolean, eventDetails: AutocompleteRootOpenChangeEventDetails) => void)
–

Event handler called when the popup is opened or closed.

onOpenChangeComplete
((open: boolean) => void)
–

Event handler called after any animations complete when the popup is opened or closed.

onValueChange
((value: string, eventDetails: AutocompleteRootChangeEventDetails) => void)
–

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

open
boolean
–

Whether the popup is currently open. Use when controlled.

openOnInputClick
boolean
false

Whether the popup opens when clicking the input.

readOnly
boolean
false

Whether the user should be unable to choose a different option from the popup.

required
boolean
false

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

submitOnItemClick
boolean
false

Whether clicking an item should submit the autocomplete's owning form. By default, clicking an item via a pointer or <kbd>Enter</kbd> key does not submit the owning form. Useful when the autocomplete is used as a single-field form search input.

value
string | number | readonly string[]
–

The input value of the autocomplete. Use when controlled.

virtualized
boolean
false

Whether the items are being externally virtualized.

AutocompleteClear

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
disabled
boolean
false

Whether the component should ignore user interaction.

icon
ReactNode
–

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

keepMounted
boolean
false

Whether the component should remain mounted in the DOM when not visible.

nativeButton
boolean
true

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 (for example, <div>).

AutocompleteCollection

PropTypeDefaultDescription
childrenReq
(item: any, index: number) => ReactNode
–

The content of the component.

AutocompleteEmpty

Accepts className, style and render, plus every native attribute of the element it renders.

AutocompleteGroup

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
items
readonly any[]
–

Items to be rendered within this group. When provided, child Collection components will use these items.

AutocompleteGroupLabel

Accepts className, style and render, plus every native attribute of the element it renders.

AutocompleteInput

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
clearIcon
ReactNode
–

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

clearProps
ComboboxClearProps
–

Props for the clear button, such as aria-label or className.

disabled
boolean
false

Whether the component should ignore user interaction.

showClear
boolean
false

Whether to show a button at the end of the input that clears it.

showTrigger
boolean
false

Whether to show a button at the end of the input that opens the list.

size
number|"lg"|"sm"|"default"
–

The size of the component.

startAddon
ReactNode
–

Decorative content, such as an icon, shown at the start of the input. It is hidden from screen readers.

triggerIcon
ReactNode
–

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

triggerProps
AutocompleteTriggerProps
–

Props for the open button, such as aria-label or className.

AutocompleteItem

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
children
ReactNode
–

The content of the component.

disabled
boolean
false

Whether the component should ignore user interaction.

index
number
–

The index of the item in the list. Improves performance when specified by avoiding the need to calculate the index automatically from the DOM.

nativeButton
boolean
false

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.

onClick
((event: BaseUIEvent<MouseEvent<HTMLDivElement, MouseEvent>>) => void)
–

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.

value
any
null

A unique value that identifies this item.

AutocompleteList

Accepts className, style and render, plus every native attribute of the element it renders.

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

The content of the component.

AutocompletePopup

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
align
"center"|"start"|"end"
start

How the calendar lines up with the trigger along that side.

alignOffset
number|OffsetFunction
–

Additional offset along the alignment axis, in pixels.

anchor
Autocomplete$1.Positioner.Props["anchor"]
–

An element to position the popup against. Defaults to the trigger.

finalFocus
boolean | RefObject<HTMLElement | null> | ((closeType: InteractionType) => boolean | void | HTMLElement | null)
–

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.
initialFocus
boolean | RefObject<HTMLElement | null> | ((openType: InteractionType) => boolean | void | HTMLElement | null)
–

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.
side
"top"|"bottom"|"left"|"right"|"inline-end"|"inline-start"
bottom

Which side of the copy button the tooltip and toast open on.

sideOffset
number|OffsetFunction
4

The gap between the trigger and the calendar, in pixels.

AutocompleteRow

Accepts className, style and render, plus every native attribute of the element it renders.

AutocompleteSeparator

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
orientation
"horizontal"|"vertical"
'horizontal'

The orientation of the separator.

AutocompleteStatus

Accepts className, style and render, plus every native attribute of the element it renders.

AutocompleteTrigger

Accepts className, style and render, plus every native attribute of the element it renders.

PropTypeDefaultDescription
disabled
boolean
false

Whether the component should ignore user interaction.

nativeButton
boolean
true

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 (for example, <div>).

AutocompleteValue

PropTypeDefaultDescription
children
ReactNode | ((value: string) => ReactNode)
–

The content of the component.