Autocomplete

An input that suggests options as you type.

Search tags

'use client';
import { Autocomplete } from '@base-ui/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 className={styles.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

Avoid when selection state is needed: 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.
Can be used for filterable command pickers: The input can be used as a filter for command items that perform an action when clicked when rendered inside the popup.
Form controls must have an accessible name: It can be created using a <label> element or the Field component. See the forms guide.

Anatomy

Import the components and place them together:

Anatomy

import { Autocomplete } from '@base-ui/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>

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.

Search movies by name or year

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.

Search tags

Grouped

Organize related options with <Autocomplete.Group> and <Autocomplete.GroupLabel> to add section headings inside the popup.

Groups are represented by an array of objects with an items property, which itself is an array of individual items for each group. An extra property, such as value, can be provided for the heading text when rendering the group label.

Example

interface ProduceGroupItem {
  value: string;
  items: string[];
}

const groups: ProduceGroupItem[] = [
  {
    value: 'Fruits',
    items: ['Apple', 'Banana', 'Orange'],
  },
  {
    value: 'Vegetables',
    items: ['Carrot', 'Lettuce', 'Spinach'],
  },
];

Select a tag

Fuzzy matching

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

Fuzzy search documentation

Limit results

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

Limit results to 8

Auto highlight

The first matching item can be automatically highlighted as the user types by specifying the autoHighlight prop on <Autocomplete.Root>. Set the prop’s value to "always" if the highlight should always be present, such as when the list is rendered inline within a dialog.

The prop can be combined with the keepHighlight and highlightItemOnHover props to configure how the highlight behaves during mouse interactions.

Auto highlight on type

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.

Search 10,000 items

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

autoHighlight

boolean | 'always'

false

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

keepHighlight

boolean

false

Name: keepHighlight
Description: Whether the highlighted item should be preserved when the pointer leaves the list.
Type: boolean | undefined
Default: false

highlightItemOnHover

boolean

true

Name: highlightItemOnHover
Description: Whether moving the pointer over items should highlight them. Disabling this prop allows CSS :hover to be differentiated from the :focus (data-highlighted) state.
Type: boolean | undefined
Default: true

actionsRef

| React.RefObject<Autocomplete.Root.Actions 
|  null>

—

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 | null> | undefined

filter

function

—

Name: filter
Description: AutocompleteFilter function used to match items vs input query.
Type: ((itemValue: ItemValue, query: string, itemToString?: ((itemValue: ItemValue) => string)) => boolean) | null | undefined

filteredItems

any[] | Group[]

—

Name: filteredItems
Description: Filtered items to display in the list. When provided, the list will use these items instead of filtering the items prop internally. Use when you want to control filtering logic externally with the useFilter() hook.
Type: any[] | Group[] | 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

inline

boolean

false

Name: inline
Description: Whether the list is rendered inline without using the popup.
Type: boolean | undefined
Default: false

itemToStringValue

function

—

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

loopFocus

boolean

true

Name: loopFocus
Description: 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 ArrowDown again from the input, or the last item can be reached by pressing ArrowUp from the input. The input is always included in the focus loop per ARIA Authoring Practices. When disabled, focus does not move when on the last element and the user presses ArrowDown, or when on the first element and the user presses ArrowUp.
Type: boolean | undefined
Default: true

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: 'list' | 'both' | 'inline' | 'none' | undefined
Default: 'list'

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

false

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

submitOnItemClick

boolean

false

Name: submitOnItemClick
Description: Whether clicking an item should submit the autocomplete’s owning form. By default, clicking an item via a pointer or Enter key does not submit the owning form. Useful when the autocomplete is used as a single-field form search input.
Type: boolean | undefined
Default: false

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

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

React.ReactNode

—

Name: children
Type: React.ReactNode | undefined

Additional Types

Autocomplete.Root.Props

Re-Export of Root props as AutocompleteRootProps

Autocomplete.Root.State

type AutocompleteRootState = {};

Autocomplete.Root.Actions

type AutocompleteRootActions = { unmount: () => void };

Autocomplete.Root.ChangeEventReason

type AutocompleteRootChangeEventReason =
  | 'trigger-press'
  | 'outside-press'
  | 'item-press'
  | 'escape-key'
  | 'list-navigation'
  | 'focus-out'
  | 'input-change'
  | 'input-clear'
  | 'clear-press'
  | 'chip-remove-press'
  | 'none';

Autocomplete.Root.ChangeEventDetails

type AutocompleteRootChangeEventDetails =
  | {
      reason: 'none';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'trigger-press';
      event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'outside-press';
      event: MouseEvent | PointerEvent | TouchEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'item-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'escape-key';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'list-navigation';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'focus-out';
      event: KeyboardEvent | FocusEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'input-change';
      event: Event | InputEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'input-clear';
      event: Event | FocusEvent | InputEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'clear-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'chip-remove-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    };

Autocomplete.Root.HighlightEventReason

type AutocompleteRootHighlightEventReason = 'keyboard' | 'pointer' | 'none';

Autocomplete.Root.HighlightEventDetails

type AutocompleteRootHighlightEventDetails =
  | BaseUIGenericEventDetail<'none', { index: number }>
  | BaseUIGenericEventDetail<'keyboard', { index: number }>
  | BaseUIGenericEventDetail<'pointer', { index: number }>;

Value

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

children

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

—

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

Additional Types

Autocomplete.Value.Props

Re-Export of Value props as AutocompleteValueProps

Autocomplete.Value.State

type AutocompleteValueState = {};

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Input.State, ) => React.CSSProperties | undefined) | undefined

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

data-popup-open

Present when the corresponding popup is open.

data-popup-side

Indicates which side the corresponding popup is positioned relative to its anchor.

data-list-empty

Present when the corresponding items list is empty.

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-popup-side`	Indicates which side the corresponding popup is positioned relative to its anchor.
`data-list-empty`	Present when the corresponding items list is empty.
`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).

Additional Types

Autocomplete.Input.Props

Re-Export of Input props as AutocompleteInputProps

Autocomplete.Input.State

type AutocompleteInputState = {
  open: boolean;
  popupSide:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start'
    | null;
  listEmpty: boolean;
  readOnly: boolean;
  disabled: boolean;
  touched: boolean;
  dirty: boolean;
  valid: boolean | null;
  filled: boolean;
  focused: boolean;
}

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Trigger.State, ) => React.CSSProperties | undefined) | undefined

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

data-popup-open

Present when the corresponding popup is open.

data-popup-side

Indicates which side the corresponding popup is positioned relative to its anchor.

data-list-empty

Present when the corresponding items list is empty.

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

data-placeholder

Present when the combobox doesn’t have a value.

Attribute	Description	-
`data-popup-open`	Present when the corresponding popup is open.
`data-popup-side`	Indicates which side the corresponding popup is positioned relative to its anchor.
`data-list-empty`	Present when the corresponding items list is empty.
`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).
`data-placeholder`	Present when the combobox doesn’t have a value.

Additional Types

Autocomplete.Trigger.Props

Re-Export of Trigger props as AutocompleteTriggerProps

Autocomplete.Trigger.State

type AutocompleteTriggerState = {
  open: boolean;
  disabled: boolean;
  popupSide:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start'
    | null;
  listEmpty: boolean;
  placeholder: boolean;
  touched: boolean;
  dirty: boolean;
  valid: boolean | null;
  filled: boolean;
  focused: boolean;
}

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Icon.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Icon.Props

Re-Export of Icon props as AutocompleteIconProps

Autocomplete.Icon.State

type AutocompleteIconState = {};

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Clear.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Clear.Props

Re-Export of Clear props as AutocompleteClearProps

Autocomplete.Clear.State

type AutocompleteClearState = {
  open: boolean;
  disabled: boolean;
  transitionStatus: TransitionStatus;
};

List

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

children

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

—

Name: children
Type: React.ReactNode | ((item: any, index: number) => React.ReactNode) | 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.List.State) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.List.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.List.Props

Re-Export of List props as AutocompleteListProps

Autocomplete.List.State

type AutocompleteListState = { empty: boolean };

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Portal.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Portal.Props

Re-Export of Portal props as AutocompletePortalProps

Autocomplete.Portal.State

type AutocompletePortalState = {};

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Backdrop.State, ) => React.CSSProperties | undefined) | undefined

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

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.

Additional Types

Autocomplete.Backdrop.Props

Re-Export of Backdrop props as AutocompleteBackdropProps

Autocomplete.Backdrop.State

type AutocompleteBackdropState = { open: boolean; transitionStatus: TransitionStatus };

Positioner

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

disableAnchorTracking

boolean

false

Name: disableAnchorTracking
Description: Whether to disable the popup from tracking any layout shift of its positioning anchor.
Type: boolean | undefined
Default: false

align

Align

'center'

Name: align
Description: How to align the popup relative to the specified side.
Type: 'start' | 'center' | '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: | 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start'; align: 'start' | 'center' | 'end'; 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

'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: | 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start'; align: 'start' | 'center' | 'end'; 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

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 | VirtualElement | React.RefObject<Element | null> | (() => Element | VirtualElement | null) | null | undefined

collisionAvoidance

CollisionAvoidance

—

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

collisionBoundary

Boundary

'clipping-ancestors'

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

collisionPadding

Padding

5

Name: collisionPadding
Description: Additional space to maintain from the edge of the collision boundary.
Type: Padding | 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

'absolute' | 'fixed'

'absolute'

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

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Positioner.State, ) => React.CSSProperties | undefined) | undefined

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

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.

Additional Types

Autocomplete.Positioner.Props

Re-Export of Positioner props as AutocompletePositionerProps

Autocomplete.Positioner.State

type AutocompletePositionerState = {
  open: boolean;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  anchorHidden: boolean;
  empty: boolean;
}

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

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: 'mouse' | 'touch' | 'pen' | 'keyboard' | '', ) => boolean | void | HTMLElement | null) | undefined

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: | 'mouse' | 'touch' | 'pen' | 'keyboard' | '', ) => boolean | void | HTMLElement | null) | undefined

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

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Popup.State, ) => React.CSSProperties | undefined) | undefined

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

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.

Additional Types

Re-Export of Popup props as AutocompletePopupProps

type AutocompletePopupState = {
  open: boolean;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  anchorHidden: boolean;
  transitionStatus: TransitionStatus;
  empty: boolean;
}

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Arrow.State, ) => React.CSSProperties | undefined) | undefined

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

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-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-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.

Additional Types

Autocomplete.Arrow.Props

Re-Export of Arrow props as AutocompleteArrowProps

Autocomplete.Arrow.State

type AutocompleteArrowState = {
  open: boolean;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  uncentered: boolean;
}

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Status.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Status.Props

Re-Export of Status props as AutocompleteStatusProps

Autocomplete.Status.State

type AutocompleteStatusState = {};

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Empty.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Empty.Props

Re-Export of Empty props as AutocompleteEmptyProps

Autocomplete.Empty.State

type AutocompleteEmptyState = {};

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) => React.ReactNode)

—

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

Additional Types

Autocomplete.Collection.Props

Re-Export of Collection props as AutocompleteCollectionProps

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Row.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Row.Props

Re-Export of Row props as AutocompleteRowProps

Autocomplete.Row.State

type AutocompleteRowState = {};

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 | undefined
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: | (( event: BaseUIEvent< React.MouseEvent<HTMLDivElement, MouseEvent> >, ) => void) | 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

React.ReactNode

—

Name: children
Type: React.ReactNode | 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.Item.State) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Item.State, ) => React.CSSProperties | undefined) | undefined

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

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.

Additional Types

Autocomplete.Item.Props

Re-Export of Item props as AutocompleteItemProps

Autocomplete.Item.State

type AutocompleteItemState = { disabled: boolean; selected: boolean; highlighted: boolean };

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.Group.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.Group.Props

Re-Export of Group props as AutocompleteGroupProps

Autocomplete.Group.State

type AutocompleteGroupState = {};

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Autocomplete.GroupLabel.State, ) => React.CSSProperties | undefined) | undefined

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

Additional Types

Autocomplete.GroupLabel.Props

Re-Export of GroupLabel props as AutocompleteGroupLabelProps

Autocomplete.GroupLabel.State

type AutocompleteGroupLabelState = {};

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: SeparatorState) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: SeparatorState, ) => React.CSSProperties | undefined) | undefined

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: SeparatorState, ) => ReactElement) | undefined

Additional Types

Autocomplete.Separator.Props

Re-Export of Separator props as AutocompleteSeparatorProps

Autocomplete.Separator.State

type AutocompleteSeparatorState = {
  orientation: 'horizontal' | 'vertical';
}

useFilter

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

Parameters

options

{ locale?: Intl.LocalesArgument }

—

Name: options
Type: { locale?: Intl.LocalesArgument } | undefined

Return value

contains

function

—

Name: contains
Type: ((item: Item, query: string, itemToString?: ((item: Item) => string)) => boolean)

startsWith

function

—

Name: startsWith
Type: ((item: Item, query: string, itemToString?: ((item: Item) => string)) => boolean)

endsWith

function

—

Name: endsWith
Type: ((item: Item, query: string, itemToString?: ((item: Item) => string)) => boolean)

useFilteredItems

Returns the internally filtered items when called inside <Autocomplete.Root>.

Return value

T[]