Autocompletar

Resumen

Usa Autocomplete para sugerencias asociadas a un campo de entrada de texto. El campo de entrada mantiene el cursor y el foco del teclado mientras las teclas de flecha resaltan sugerencias. Usa Select cuando el usuario debe elegir un valor de una lista fija. Dropdown sigue siendo el componente de nivel superior para menús y selectores.

”Uso”

Pase items a Root y represéntelos mediante List para que el filtrado actualice las sugerencias visibles. autoHighlight="always" resalta el primer resultado cada vez que se abre la lista.

import { Autocomplete } from 'twenty-ui/primitives/input';

const FRUITS = ['Apple', 'Banana', 'Cherry'];

export const FruitInput = () => (
  <Autocomplete.Root items={FRUITS} autoHighlight="always">
    <Autocomplete.InputGroup>
      <Autocomplete.Input aria-label="Fruit" placeholder="Search fruits" />
    </Autocomplete.InputGroup>
    <Autocomplete.Portal>
      <Autocomplete.Positioner>
        <Autocomplete.Popup>
          <Autocomplete.Empty>No fruits found</Autocomplete.Empty>
          <Autocomplete.List>
            {(fruit: string) => (
              <Autocomplete.Item key={fruit} value={fruit}>
                {fruit}
              </Autocomplete.Item>
            )}
          </Autocomplete.List>
        </Autocomplete.Popup>
      </Autocomplete.Positioner>
    </Autocomplete.Portal>
  </Autocomplete.Root>
);

value y onValueChange controlan el texto de la entrada. Use defaultValue para un valor inicial no controlado. El estado de apertura es independiente: usa open y onOpenChange, o defaultOpen. Item.onClick gestiona tanto la selección mediante puntero como Intro desde la entrada. mode="list" filtra sin cambiar el texto de entrada al resaltar. mode="both" también proporciona completado en línea. mode="inline" conserva todos los elementos y proporciona completado en línea; mode="none" conserva todos los elementos sin completado en línea. readOnly evita que el completado en línea cambie la entrada.

Anatomía

Mantén las partes relacionadas dentro de un Autocomplete.Root montado. Compón por separado el destino del portal, el contenedor de posicionamiento y el contenido. InputGroup agrupa opcionalmente el campo de entrada con controles adyacentes y ancla la ventana emergente a ese grupo.

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)

Parte	Propósito y destino nativo
`Root`	Gestiona el valor de entrada, el filtrado, los elementos resaltados y el estado de apertura. No renderiza ningún elemento.
`Valor`	Lee el texto de entrada mediante elementos secundarios o una función de renderizado. No renderiza ningún elemento.
`InputGroup`	Agrupa el campo de entrada y los controles adyacentes. Tiene como destino un div.
`Entrada`	Representa la entrada del cuadro combinado y conserva el foco del teclado. Tiene como destino un input.
`Disparador`	Abre o cierra las sugerencias. Tiene como destino un botón.
`Icon`	Contiene un indicador de activación. Tiene como destino un span.
`Limpiar`	Borra el valor de entrada. Tiene como destino un botón.
`Portal`	Elige el destino y la política de montaje. Tiene como destino su div de portal.
`Backdrop`	Proporciona una superposición opcional debajo de la ventana emergente. Tiene como destino un div.
`Positioner`	Gestiona el ancla, la alineación, los desplazamientos y la gestión de colisiones. Tiene como destino su div.
`Popup`	Renderiza el contenido de las sugerencias y el comportamiento de enfoque opcional. Tiene como destino su div.
`Arrow`	Proporciona una flecha posicionada opcional dentro de Popup. Tiene como destino un div.
`Lista`	Renderiza los elementos filtrados. Tiene como destino un div con el rol de cuadro de lista o cuadrícula.
`Item`	Representa una sugerencia y gestiona la selección mediante puntero o teclado. Tiene como destino un div.
`Grupo`	Agrupa elementos relacionados. Tiene como destino un div.
`GroupLabel`	Etiqueta su grupo principal. Tiene como destino un div.
`Row`	Agrupa una fila de elementos cuando `Root.grid` está habilitado. Tiene como destino un div.
`Collection`	Renderiza elementos filtrados mediante una función secundaria. No renderiza ningún elemento.
`Separator`	Separa visualmente elementos o grupos. Tiene como destino un div.
`Vacío`	Anuncia cuando no hay elementos coincidentes disponibles. Tiene como destino un div.
`Estado`	Anuncia cambios, como el estado de carga asíncrona. Tiene como destino un div.

Las partes renderizadas conservan los atributos nativos, controladores, referencias, className y style basados en el estado, y la composición de render de elementos o funciones de la API de Base UI instalada. Las props nativas y las referencias tienen como destino el propio elemento de la parte. Los componentes personalizados deben reenviar las props y referencias proporcionadas. Las props de partes públicas y los tipos de estado se exportan desde twenty-ui/primitives/input, junto con las acciones de Root y los tipos de detalles de eventos de cambio/resaltado. Autocomplete.useFilter() proporciona coincidencias de contains, startsWith y endsWith adaptadas a la configuración regional. Autocomplete.useFilteredItems\<TItem>() lee la colección filtrada internamente en Root. Trata ese resultado como de solo lectura.

Objetos y elementos agrupados

Los elementos pueden ser cadenas u objetos arbitrarios. Usa itemToStringValue para proporcionar el texto usado para el filtrado, el completado y el envío de formularios. Los objetos con la forma { value, label } usan su etiqueta automáticamente. Renderiza el mismo valor de elemento proporcionado a través de Root; no se requiere ninguna forma de elemento específica de Twenty ni prop de igualdad de selección. Autocomplete gestiona la entrada de texto en lugar de un valor de objeto seleccionado independiente. Para datos agrupados, pasa grupos con un array items. Root conserva el tipo de elemento para itemToStringValue y onItemHighlighted. Renderiza los elementos secundarios filtrados de cada grupo mediante Group y Collection:

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 = () => (
  <Text
    style={{ display: 'grid', alignContent: 'start', gap: 8, width: '100%' }}
  >
    <label htmlFor="grouped-city">
      <Text render={<span />}>City</Text>
    </label>
    <Autocomplete.Root
      items={CITY_GROUPS}
      itemToStringValue={(city) => city.name}
      autoHighlight="always"
    >
      <Autocomplete.Input id="grouped-city" placeholder="Search cities" />
      <Autocomplete.Portal>
        <Autocomplete.Positioner>
          <Autocomplete.Popup>
            <Autocomplete.Empty>No matching cities</Autocomplete.Empty>
            <Autocomplete.List>
              {(group: CityGroup) => (
                <Autocomplete.Group key={group.label} items={group.items}>
                  <Autocomplete.GroupLabel>
                    {group.label}
                  </Autocomplete.GroupLabel>
                  <Autocomplete.Collection>
                    {(city: City) => (
                      <Autocomplete.Item
                        key={city.id}
                        value={city}
                        description={city.country}
                      >
                        {city.name}
                      </Autocomplete.Item>
                    )}
                  </Autocomplete.Collection>
                </Autocomplete.Group>
              )}
            </Autocomplete.List>
          </Autocomplete.Popup>
        </Autocomplete.Positioner>
      </Autocomplete.Portal>
    </Autocomplete.Root>
  </Text>
);

Item.startIcon, Item.endIcon y Item.description proporcionan contenido complementario. Compón Trigger y Clear con Button de Twenty UI mediante render. Icon puede contener un icono de twenty-ui/icon. Mantén Status y Empty montados mientras actualizas sus elementos secundarios para que los lectores de pantalla puedan anunciar los cambios.

Filtrado externo y sugerencias del servidor

Usa filteredItems cuando tu aplicación gestione el filtrado. Debe conservar la estructura plana o agrupada de items. filter acepta una función de coincidencia personalizada; filter={null} desactiva el filtrado interno para los resultados ya filtrados por un servidor.

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 (
    <Autocomplete.Root
      items={CITIES}
      filteredItems={filteredItems}
      value={value}
      onValueChange={setValue}
      autoHighlight="always"
    >
      <Autocomplete.Input aria-label="City prefix" />
      <Autocomplete.Portal>
        <Autocomplete.Positioner>
          <Autocomplete.Popup>
            <Autocomplete.Empty>No matching cities</Autocomplete.Empty>
            <Autocomplete.List>
              {(city: string) => (
                <Autocomplete.Item key={city} value={city}>
                  {city}
                </Autocomplete.Item>
              )}
            </Autocomplete.List>
          </Autocomplete.Popup>
        </Autocomplete.Positioner>
      </Autocomplete.Portal>
    </Autocomplete.Root>
  );
};

Mantén Root montado cuando los resultados lleguen de forma asíncrona. Controla open de forma independiente para que una respuesta pueda abrir sugerencias mientras el campo de entrada permanece enfocado. Un Status montado puede anunciar la carga; actualiza Empty cuando la respuesta completada no tenga resultados. El elemento principal gestiona el rebote, la cancelación de solicitudes y la protección contra respuestas obsoletas. onValueChange y onOpenChange reciben los detalles del evento ascendente, incluidos reason, event nativo, trigger, cancel() y allowPropagation(). Los llamadores controlados deciden qué actualizaciones solicitadas confirmar. Por ejemplo, ignora el cambio de valor escape-key para conservar una consulta del servidor, o ignora la apertura input-change hasta que lleguen los resultados. onItemHighlighted recibe el elemento original tipado y el motivo de su resaltado. La cancelación conserva la semántica de Base UI instalada; no reemplaza la política de estado controlado de la aplicación.

Composición de entrada y formularios nativos

Input acepta size="sm" o size="md" y usa los mismos estilos que Input. Compónlo con una entrada existente mediante render. El control compuesto controla entonces su apariencia: Input no añade estilos de Input e ignora size, pero sigue pasando tu className, atributos nativos, controladores, ref y atributos de estado. Reenvíalos al elemento input real. Renderiza Input de Twenty UI para mantener la apariencia estándar. InputGroup proporciona diseño y un ancla sin añadir bordes a la entrada. Puede contener chips o representar un contenedor existente. Usa InputGroup mediante su prop render cuando todo el grupo necesite el estilo de entrada, como ocurre con las sugerencias de objetos agrupados. Un Input sin render dentro de él elimina su propio borde. Asigne a la entrada una etiqueta accesible o compóngala con Field. Root conserva el comportamiento ascendente de name, form, disabled, readOnly y de los formularios nativos. Los atributos nativos y la referencia de Input tienen como destino su entrada. submitOnItemClick permite el envío del formulario al seleccionar una sugerencia; el valor predeterminado no realiza el envío. Input conserva la gestión nativa de IME de Base UI, incluidos los eventos de composición y su protección de confirmación mediante teclado. La versión instalada de Base UI conserva una consulta no controlada al restablecer un formulario nativo. Para una consulta controlada, gestiona el onReset del formulario y restaura el valor inicial de la aplicación.

Ubicación, destino del portal y descarte

Positioner usa de forma predeterminada side="bottom", align="start" y sideOffset={8}. Conserva el contrato de anclaje y posicionamiento de Base UI instalado, incluidos anclajes de elemento/referencia/función/virtuales, desplazamientos funcionales, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky y disableAnchorTracking. Configúralos en Positioner. DirectionProvider controla la ubicación lógica y la dirección del DOM. Popup usa el ancho del ancla como ancho mínimo. Establece su width para proporcionar un ancho de contenido fijo. Sus props nativas, estilos, composición de renderizado y referencia tienen como destino el elemento de contenido de forma independiente de Positioner y Portal. initialFocus y finalFocus de Popup conservan las opciones de enfoque ascendentes. De forma predeterminada, las sugerencias mantienen el enfoque en el campo de entrada. Configura container y keepMounted en Portal. Al omitir el contenedor, se usa el destino ThemeProvider con ámbito más cercano y, después, el portal principal o el cuerpo del documento de Base UI. Un null explícito espera sin renderizar hasta que se proporcione un contenedor. Los destinos de Element, ShadowRoot y referencia se transfieren a Base UI. Una referencia sin resolver conserva la alternativa de portal principal/cuerpo de Base UI. El destino con ámbito predeterminado conserva sus tokens CSS y su esquema de color. Un destino explícito hereda CSS de su ámbito real del DOM, así que colócalo dentro del ámbito de tema previsto o proporciona esos estilos allí. El contexto y la dirección de React permanecen disponibles a través de los portales. Los destinos ShadowRoot necesitan el CSS y los estilos de tema de la biblioteca en ese árbol de sombra. Las teclas de flecha cambian el elemento resaltado mientras el campo de entrada mantiene el enfoque. Intro lo selecciona; Escape y la interacción externa solicitan el descarte mediante la semántica ascendente. Una pulsación externa puede activar el control de destino. Los selectores de nivel superior pueden gestionar una política de activación distinta en su adaptador. Llama a event.preventBaseUIHandler() en el onKeyDown de Input para omitir el controlador integrado de una tecla que gestiones tú mismo. Usa también event.preventDefault() al suprimir la acción nativa del navegador. Root.inline con open renderiza sugerencias sin el conjunto de la ventana emergente. Los elementos en línea conservan sus callbacks de selección onClick, pero el componente ascendente instalado rellena la entrada automáticamente solo cuando su Popup está presente. Gestiona Item.onClick cuando la selección en línea deba actualizar el texto controlado. Root.grid y Row admiten la navegación por cuadrícula. Estos modos conservan las API de colección y renderizado ascendentes.

Migración

Envuelve Popup con Autocomplete.Positioner y Autocomplete.Portal. Positioner requiere el contexto de Portal; las sugerencias en línea omiten todo el conjunto de la ventana emergente. Mueve las props de ubicación, ancla y colisión de Popup a Positioner. Mueve la configuración de container y de montaje a Portal. Mantén el ancho, los estilos de contenido, las props nativas, los controladores y las referencias en Popup. Usa un elemento secundario Arrow explícito para una flecha. Dentro de los componentes frontales, conserva la política existente de portal con ámbito. Esta API no amplía los destinos de portal del renderizador ni las capacidades de geometría, desplazamiento y descarte; esas capacidades del renderizador tienen una gestión independiente. Los adaptadores de selectores de producción conservan sus flujos de trabajo de activación deliberados.

”Props”

La referencia se genera a partir de los tipos de componentes públicos. Los atributos nativos, los nombres accesibles y los controladores de eventos también se aceptan en las partes renderizadas.

Autocomplete.Root

RefObject<AutocompleteRootActions | null>

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.

boolean | "always"

default:"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.

boolean

default:"false"

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

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.

boolean

default:"false"

Whether the component should ignore user interaction.

AutocompleteRootProps<TItem>["filter"]

Filter function used to match items against the input query.

readonly TItem[] | readonly { items: readonly TItem[] }[]

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.

string

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

boolean

default:"false"

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

boolean

default:"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.

string

The id of the component.

boolean

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

Ref<HTMLInputElement>

A ref to the hidden input element.

readonly TItem[] | readonly { items: readonly TItem[] }[]

Flat items or groups with an items array. Preserves the upstream item type; nullish entries are not supported.

(itemValue: TItem) => 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.

boolean

default:"false"

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

number

default:"-1"

The maximum number of items to display in the list.

LocalesArgument

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

boolean

default:"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. 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>.

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.

"both" | "inline" | "list" | "none"

default:"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.

string

Identifies the field when a form is submitted.

(highlightedValue: TItem | undefined, 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.

((open: boolean, eventDetails: AutocompleteRootOpenChangeEventDetails) => void)

Event handler called when the popup is opened or closed.

((open: boolean) => void)

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

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

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

boolean

Whether the popup is currently open. Use when controlled.

boolean

default:"false"

Whether the popup opens when clicking the input.

boolean

default:"false"

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

boolean

default:"false"

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

boolean

default:"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.

string | number | readonly string[]

The input value of the autocomplete. Use when controlled.

boolean

default:"false"

Whether the items are being externally virtualized.

Autocomplete.Value

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

Content or render function receiving the current input text.

Autocomplete.Trigger

string | ((state: AutocompleteTriggerState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

boolean

default:"false"

Whether the component should ignore user interaction.

boolean

default:"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>).

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AutocompleteTriggerState>

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.

CSSProperties | ((state: AutocompleteTriggerState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.InputGroup

string | ((state: AutocompleteInputGroupState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AutocompleteInputGroupState>

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.

CSSProperties | ((state: AutocompleteInputGroupState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Input

string | ((state: ComboboxInputState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

boolean

default:"false"

Whether the component should ignore user interaction.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxInputState>

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.

"md" | "sm"

Visual size of the input. Inside an InputGroup, the group size applies. Not accepted with render.

CSSProperties | ((state: ComboboxInputState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Icon

string | ((state: ComboboxIconState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxIconState>

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.

CSSProperties | ((state: ComboboxIconState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Clear

string | ((state: ComboboxClearState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

boolean

default:"false"

Whether the component should ignore user interaction.

boolean

default:"false"

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

boolean

default:"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>).

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxClearState>

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.

CSSProperties | ((state: ComboboxClearState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Portal

string | ((state: ComboboxPortalState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

Portal destination. Omitted uses the scoped theme container; explicit null waits without rendering. Element, ShadowRoot and ref targets pass through to Base UI.

boolean

default:"false"

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

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxPortalState>

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.

CSSProperties | ((state: ComboboxPortalState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Backdrop

string | ((state: ComboboxBackdropState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxBackdropState>

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.

CSSProperties | ((state: ComboboxBackdropState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Positioner

"center" | "end" | "start"

default:"start"

Alignment relative to the anchor. Defaults to start.

number | OffsetFunction

default:"0"

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.

An element to position the popup against. By default, the popup will be positioned against the trigger.

number

default:"5"

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.

string | ((state: ComboboxPositionerState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

CollisionAvoidance

Determines how to handle collisions when positioning the popup.side controls overflow on the preferred placement axis (top/bottom or left/right):

'flip': keep the requested side when it fits; otherwise try the opposite side (top and bottom, or left and right).
'shift': never change side; keep the requested side and move the popup within the clipping boundary so it stays visible.
'none': do not correct side-axis overflow.

align controls overflow on the alignment axis (start/center/end):

'flip': keep side, but swap start and end when the requested alignment overflows.
'shift': keep side and requested alignment, then nudge the popup along the alignment axis to fit.
'none': do not correct alignment-axis overflow.

fallbackAxisSide controls fallback behavior on the perpendicular axis when the preferred axis cannot fit:

'start': allow perpendicular fallback and try the logical start side first (top before bottom, or left before right in LTR).
'end': allow perpendicular fallback and try the logical end side first (bottom before top, or right before left in LTR).
'none': do not fallback to the perpendicular axis.

When side is 'shift', explicitly setting align only supports 'shift' or 'none'. If align is omitted, it defaults to 'flip'.

Boundary

default:"clipping-ancestors"

An element or a rectangle that delimits the area that the popup is confined to.

Padding

default:"5"

Additional space to maintain from the edge of the collision boundary.

boolean

default:"false"

Whether to disable the popup from tracking any layout shift of its positioning anchor.

"absolute" | "fixed"

default:"absolute"

Determines which CSS position property to use.

Ref<HTMLDivElement>

Ref to the positioning div, separate from Popup and Portal.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxPositionerState>

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.

default:"bottom"

Which side of the anchor element to align the popup against. May automatically change to avoid collisions.

number | OffsetFunction

default:"8"

Distance from the anchor. Defaults to 8; supports functional offsets.

boolean

default:"false"

Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.

CSSProperties | ((state: ComboboxPositionerState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

CSS class applied to the element, or a function that returns a class based on the component’s state.

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.

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.

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.

Style applied to the element, or a function that returns a style object based on the component’s state.

Width of the popup. Overrides its default minimum anchor width.

Autocomplete.Arrow

string | ((state: ComboboxArrowState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxArrowState>

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.

CSSProperties | ((state: ComboboxArrowState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.List

string | ((state: ComboboxListState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxListState>

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.

CSSProperties | ((state: ComboboxListState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Status

string | ((state: ComboboxStatusState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxStatusState>

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.

CSSProperties | ((state: ComboboxStatusState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Group

string | ((state: ComboboxGroupState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

readonly any[]

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

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxGroupState>

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.

CSSProperties | ((state: ComboboxGroupState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.GroupLabel

string | ((state: ComboboxGroupLabelState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxGroupLabelState>

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.

CSSProperties | ((state: ComboboxGroupLabelState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Item

string | ((state: AutocompleteItemState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactNode

Supporting text, placed according to descriptionPlacement.

"end" | "inline"

default:"inline"

Where the description renders: inline after the content or at the end of the row.

boolean

default:"false"

Whether the component should ignore user interaction.

ReactNode

Icon rendered after the content.

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.

boolean

default:"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.

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

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AutocompleteItemState>

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.

ReactNode

Icon rendered before the content.

CSSProperties | ((state: AutocompleteItemState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

any

default:"null"

A unique value that identifies this item.

Autocomplete.Row

string | ((state: ComboboxRowState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxRowState>

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.

CSSProperties | ((state: ComboboxRowState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Collection

(item: any, index: number) => ReactNode

required

Render function receiving each filtered item and its index.

Autocomplete.Empty

string | ((state: ComboboxEmptyState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxEmptyState>

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.

CSSProperties | ((state: ComboboxEmptyState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Autocomplete.Separator

string | ((state: AutocompleteSeparatorState) => string | undefined)

CSS class applied to the element, or a function that returns a class based on the component’s state.

"horizontal" | "vertical"

default:"horizontal"

The orientation of the separator.

ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, AutocompleteSeparatorState>

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.

CSSProperties | ((state: AutocompleteSeparatorState) => CSSProperties | undefined)

Style applied to the element, or a function that returns a style object based on the component’s state.

Getting Started

Core Concepts

Resumen

”Uso”

Anatomía

Objetos y elementos agrupados

Filtrado externo y sugerencias del servidor

Composición de entrada y formularios nativos

Ubicación, destino del portal y descarte

Migración

”Props”

Autocomplete.Root

Autocomplete.Value

Autocomplete.Trigger

Autocomplete.InputGroup

Autocomplete.Input

Autocomplete.Icon

Autocomplete.Clear

Autocomplete.Portal

Autocomplete.Backdrop

Autocomplete.Positioner

Autocomplete.Arrow

Autocomplete.List

Autocomplete.Status

Autocomplete.Group

Autocomplete.GroupLabel

Autocomplete.Item

Autocomplete.Row

Autocomplete.Collection

Autocomplete.Empty

Autocomplete.Separator

​Resumen

​”Uso”

​Anatomía

​Objetos y elementos agrupados

​Filtrado externo y sugerencias del servidor

​Composición de entrada y formularios nativos

​Ubicación, destino del portal y descarte

​Migración

​”Props”

​Autocomplete.Root

​Autocomplete.Value

​Autocomplete.Trigger

​Autocomplete.InputGroup

​Autocomplete.Input

​Autocomplete.Icon

​Autocomplete.Clear

​Autocomplete.Portal

​Autocomplete.Backdrop

​Autocomplete.Positioner

​Autocomplete.Popup

​Autocomplete.Arrow

​Autocomplete.List

​Autocomplete.Status

​Autocomplete.Group

​Autocomplete.GroupLabel

​Autocomplete.Item

​Autocomplete.Row

​Autocomplete.Collection

​Autocomplete.Empty

​Autocomplete.Separator

Resumen

”Uso”

Anatomía

Objetos y elementos agrupados

Filtrado externo y sugerencias del servidor

Composición de entrada y formularios nativos

Ubicación, destino del portal y descarte

Migración

”Props”

Autocomplete.Root

Autocomplete.Value

Autocomplete.Trigger

Autocomplete.InputGroup

Autocomplete.Input

Autocomplete.Icon

Autocomplete.Clear

Autocomplete.Portal

Autocomplete.Backdrop

Autocomplete.Positioner

Autocomplete.Popup

Autocomplete.Arrow

Autocomplete.List

Autocomplete.Status

Autocomplete.Group

Autocomplete.GroupLabel

Autocomplete.Item

Autocomplete.Row

Autocomplete.Collection

Autocomplete.Empty

Autocomplete.Separator