> ## Documentation Index
> Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Autocomplete
> Suggest values while the user types and keeps focus in the input.
export const StoryEmbed = ({storyId, title, height = 120}) => <>
Open in Storybook
;
Use `Autocomplete` for suggestions attached to a text input. The input keeps its caret and keyboard focus while arrow keys highlight suggestions. Use [Select](/ui/primitives/input/select) when the user must choose a value from a fixed list. [Dropdown](/ui/components/navigation/dropdown) remains the higher-level component for menus and pickers.
## Usage
Pass `items` to `Root` and render them through `List` so filtering updates the visible suggestions. `autoHighlight="always"` highlights the first result whenever the list opens.
```tsx theme={null}
import { Autocomplete } from 'twenty-ui/primitives/input';
const FRUITS = ['Apple', 'Banana', 'Cherry'];
export const FruitInput = () => (
No fruits found
{(fruit: string) => (
{fruit}
)}
);
```
`value` and `onValueChange` control the input text. Use `defaultValue` for an uncontrolled initial value. Open state is independent: use `open` and `onOpenChange`, or `defaultOpen`. `Item.onClick` handles both pointer selection and Enter from the input.
`mode="list"` filters without changing input text on highlight. `mode="both"` also supplies inline completion. `mode="inline"` keeps all items and supplies inline completion; `mode="none"` keeps all items without inline completion. `readOnly` prevents inline completion from changing the input.
## Anatomy
Keep related parts inside a mounted `Autocomplete.Root`. Compose the portal destination, positioning wrapper, and content separately. `InputGroup` optionally groups the input with adjacent controls and anchors the popup to that group.
```text theme={null}
Autocomplete.Root
├── Autocomplete.InputGroup (optional)
│ ├── Autocomplete.Input
│ ├── Autocomplete.Clear (optional)
│ └── Autocomplete.Trigger (optional)
│ └── Autocomplete.Icon (optional)
├── Autocomplete.Portal
│ ├── Autocomplete.Backdrop (optional)
│ └── Autocomplete.Positioner
│ └── Autocomplete.Popup
│ ├── Autocomplete.Arrow (optional)
│ ├── Autocomplete.Empty
│ └── Autocomplete.List
│ ├── Autocomplete.Item
│ ├── Autocomplete.Group (optional)
│ │ ├── Autocomplete.GroupLabel
│ │ └── Autocomplete.Collection
│ │ └── Autocomplete.Item
│ ├── Autocomplete.Row (optional, with Root.grid)
│ │ └── Autocomplete.Item
│ └── Autocomplete.Separator (optional)
├── Autocomplete.Status (optional)
└── Autocomplete.Value (optional)
```
| Part | Purpose and native target |
| - | - |
| `Root` | Owns input value, filtering, highlights, and open state. Renders no element. |
| `Value` | Reads the input text through children or a render function. Renders no element. |
| `InputGroup` | Groups the input and adjacent controls. Targets a div. |
| `Input` | Renders the combobox input and retains keyboard focus. Targets an input. |
| `Trigger` | Opens or closes suggestions. Targets a button. |
| `Icon` | Contains a trigger indicator. Targets a span. |
| `Clear` | Clears the input value. Targets a button. |
| `Portal` | Chooses the destination and mounting policy. Targets its portal div. |
| `Backdrop` | Supplies an optional overlay beneath the popup. Targets a div. |
| `Positioner` | Owns anchor, alignment, offsets, and collision handling. Targets its div. |
| `Popup` | Renders the suggestion content and optional focus behavior. Targets its div. |
| `Arrow` | Supplies an optional positioned arrow inside Popup. Targets a div. |
| `List` | Renders filtered items. Targets a div with the listbox or grid role. |
| `Item` | Renders a suggestion and handles pointer or keyboard selection. Targets a div. |
| `Group` | Groups related items. Targets a div. |
| `GroupLabel` | Labels its parent group. Targets a div. |
| `Row` | Groups a row of items when `Root.grid` is enabled. Targets a div. |
| `Collection` | Renders filtered items through a function child. Renders no element. |
| `Separator` | Separates items or groups visually. Targets a div. |
| `Empty` | Announces when no matching items are available. Targets a div. |
| `Status` | Announces changes such as asynchronous loading status. Targets a div. |
Rendered parts retain native attributes, handlers, refs, state-based `className` and `style`, and element/function `render` composition from the installed Base UI API. Native props and refs target the part's own element. Custom components must forward supplied props and refs. Public part props and state types are exported from `twenty-ui/primitives/input`, together with Root actions and change/highlight event detail types.
`Autocomplete.useFilter()` supplies locale-aware `contains`, `startsWith`, and `endsWith` matching. `Autocomplete.useFilteredItems()` reads the internally filtered collection under Root. Treat that result as read-only.
## Object and grouped items
Items can be strings or arbitrary objects. Use `itemToStringValue` to supply the text used for filtering, completion, and form submission. Objects shaped as `{ value, label }` use their label automatically. Render the same item value supplied through Root; no Twenty-specific item shape or selection equality prop is required. Autocomplete owns text input rather than a separate selected object value.
For grouped data, pass groups with an `items` array. Root preserves the item type for `itemToStringValue` and `onItemHighlighted`. Render each group's filtered children through `Group` and `Collection`:
```tsx theme={null}
import { Autocomplete } from 'twenty-ui/primitives/input';
import { Text } from 'twenty-ui/primitives/typography';
type City = { id: number; name: string; country: string };
type CityGroup = { label: string; items: City[] };
const CITY_GROUPS: CityGroup[] = [
{
label: 'Europe',
items: [
{ id: 1, name: 'Paris', country: 'France' },
{ id: 2, name: 'Lisbon', country: 'Portugal' },
],
},
];
export const GroupedCityInput = () => (
city.name}
autoHighlight="always"
>
No matching cities
{(group: CityGroup) => (
{group.label}
{(city: City) => (
{city.name}
)}
)}
);
```
`Item.startIcon`, `Item.endIcon`, and `Item.description` provide supporting content. Compose `Trigger` and `Clear` with Twenty UI [Button](/ui/primitives/input/button) through `render`. `Icon` can contain an icon from `twenty-ui/icon`. Keep `Status` and `Empty` mounted while updating their children so screen readers can announce changes.
## External filtering and server suggestions
Use `filteredItems` when your application owns filtering. It must preserve the flat or grouped structure of `items`. `filter` accepts a custom matching function; `filter={null}` disables internal filtering for results already filtered by a server.
```tsx theme={null}
import { useState } from 'react';
import { Autocomplete } from 'twenty-ui/primitives/input';
const CITIES = ['Paris', 'London', 'Lisbon'];
export const CityPrefixInput = () => {
const [value, setValue] = useState('');
const { startsWith } = Autocomplete.useFilter();
const filteredItems = CITIES.filter((city) => startsWith(city, value));
return (
No matching cities
{(city: string) => (
{city}
)}
);
};
```
Keep Root mounted when results arrive asynchronously. Control `open` independently so a response can open suggestions while the input remains focused. A mounted `Status` can announce loading; update `Empty` when the completed response has no results. The parent owns debounce, request cancellation, and stale response protection.
`onValueChange` and `onOpenChange` receive the upstream event details, including `reason`, native `event`, `trigger`, `cancel()`, and `allowPropagation()`. Controlled callers decide which requested updates to commit. For example, ignore the `escape-key` value change to keep a server query, or ignore `input-change` opening until results arrive. `onItemHighlighted` receives the original typed item and its highlight reason. Cancellation keeps the installed Base UI semantics; it does not replace the application's controlled-state policy.
## Input composition and native forms
`Input` accepts `size="sm"` or `size="md"` and uses the same styles as [Input](/ui/primitives/input/input). Compose it with an existing input using `render`. The composed control then owns its look: `Input` adds no Input styles and ignores `size`, but still passes your `className`, native attributes, handlers, ref, and state attributes. Forward them to the actual input element. Render Twenty UI `Input` to keep the standard look.
`InputGroup` provides layout and an anchor without adding input borders. It can contain chips or render an existing wrapper. Use [InputGroup](/ui/primitives/input/input-group) through its `render` prop when the whole group needs input styling, as the grouped object suggestions story does. An `Input` without `render` inside it drops its own border. Give the input an accessible label or compose it with [Field](/ui/primitives/input/field).
Root preserves the upstream `name`, `form`, `disabled`, `readOnly`, and native form behavior. Input's native attributes and ref target its input. `submitOnItemClick` opts into form submission when selecting a suggestion; the default does not submit.
Input preserves Base UI's native IME handling, including composition events and its keyboard confirmation guard.
The installed Base UI version retains an uncontrolled query on native form reset. For a controlled query, handle the form's `onReset` and restore the application's initial value.
## Placement, portal destination, and dismissal
`Positioner` defaults to `side="bottom"`, `align="start"`, and `sideOffset={8}`. It retains the installed Base UI anchor and positioning contract, including element/ref/function/virtual anchors, functional offsets, `positionMethod`, `collisionBoundary`, `collisionPadding`, `collisionAvoidance`, `arrowPadding`, `sticky`, and `disableAnchorTracking`. Configure these on Positioner. DirectionProvider controls logical placement and DOM direction.
`Popup` uses the anchor width as its minimum width. Set its `width` to supply a fixed content width. Its native props, styles, render composition, and ref target the content element independently of Positioner and Portal. Popup's `initialFocus` and `finalFocus` retain upstream focus options. By default, suggestions keep focus in the input.
Configure `container` and `keepMounted` on `Portal`. Omitting the container uses the nearest scoped ThemeProvider destination, then Base UI's parent portal or document body. An explicit `null` waits without rendering until a container is supplied. Element, ShadowRoot, and ref destinations pass through to Base UI. An unresolved ref retains Base UI's parent-portal/body fallback.
The default scoped destination preserves its CSS tokens and color scheme. An explicit destination inherits CSS from its actual DOM scope, so place it inside the intended theme scope or supply those styles there. React context and direction remain available across portals. ShadowRoot targets need the library's CSS and theme styles in that shadow tree.
Arrow keys change the highlighted item while the input keeps focus. Enter selects it; Escape and outside interaction request dismissal using upstream semantics. An outside press can activate the destination control. Higher-level pickers can own a different activation policy in their adapter. Call `event.preventBaseUIHandler()` in Input's `onKeyDown` to skip the built-in handler for a key you handle yourself. Use `event.preventDefault()` as well when suppressing the browser's native action.
`Root.inline` with `open` renders suggestions without the popup assembly. Inline items retain their `onClick` selection callbacks, but the installed upstream component fills the input automatically only when its Popup is present. Handle `Item.onClick` when inline selection should update your controlled text. `Root.grid` and `Row` support grid navigation. These modes retain the upstream collection and rendering APIs.
## Migration
Wrap Popup with `Autocomplete.Positioner` and `Autocomplete.Portal`. Positioner requires the Portal context; inline suggestions omit the whole popup assembly. Move placement, anchor, and collision props from Popup to Positioner. Move `container` and mounting configuration to Portal. Keep width, content styles, native props, handlers, and refs on Popup. Use an explicit `Arrow` child for an arrow.
Inside front components, keep the existing scoped portal policy. This API does not expand renderer portal destinations or geometry, scrolling, and dismissal capabilities; those renderer capabilities have separate ownership. Production picker adapters retain their deliberate activation workflows.
## Props
The reference is generated from the public component types. Native attributes, accessible names, and event handlers are also accepted on rendered parts.
### Autocomplete.Root
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.
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.
Whether the popup is initially open.
To render a controlled popup, use the `open` prop instead.
The uncontrolled input value of the autocomplete when it's initially rendered.
To render a controlled autocomplete, use the `value` prop instead.
Whether the component should ignore user interaction.
Filter function used to match items against the input query.
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.
Identifies the form that owns the internal input.
Useful when the autocomplete is rendered outside the form.
Whether list items are presented in a grid layout.
When enabled, arrow keys navigate across rows and columns inferred from DOM rows.
Whether moving the pointer over items should highlight them.
Disabling this prop allows CSS `:hover` to be differentiated from the `:focus` (`data-highlighted`) state.
The id of the component.
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: ``
A ref to the hidden input element.
Flat items or groups with an items array. Preserves the upstream item type; nullish entries are not supported.
When the item values are objects (``), 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.
Whether the highlighted item should be preserved when the pointer leaves the list.
The maximum number of items to display in the list.
The locale to use for string comparison.
Defaults to the user's runtime locale.
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](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/).
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\.
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.
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.
Identifies the field when a form is submitted.
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.
Event handler called when the popup is opened or closed.
Event handler called after any animations complete when the popup is opened or closed.
Event handler called when the input value of the autocomplete changes.
Whether the popup is currently open. Use when controlled.
Whether the popup opens when clicking the input.
Whether the user should be unable to choose a different option from the popup.
Whether the user must choose a value before submitting a form.
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.
The input value of the autocomplete. Use when controlled.
Whether the items are being externally virtualized.
### Autocomplete.Value
Content or render function receiving the current input text.
### Autocomplete.Trigger
CSS class applied to the element, or a function that
returns a class based on the component's state.
Whether the component should ignore user interaction.
Whether the component renders a native `