Обзор
ИспользуйтеAutocomplete для предложений, связанных с текстовым полем. Поле ввода сохраняет положение курсора и фокус клавиатуры, пока клавиши со стрелками выделяют предложения. Используйте Select, когда пользователь должен выбрать значение из фиксированного списка. Dropdown остаётся компонентом более высокого уровня для меню и средств выбора.
Использование
Передайтеitems в Root и отрисуйте их через List, чтобы фильтрация обновляла видимые предложения. autoHighlight="always" выделяет первый результат при каждом открытии списка.
value и onValueChange управляют текстом поля ввода. Используйте defaultValue для неконтролируемого начального значения. Состояние открытия независимо: используйте open и onOpenChange или defaultOpen. Item.onClick обрабатывает как выбор указателем, так и нажатие Enter в поле ввода.
mode="list" фильтрует, не изменяя текст ввода при выделении. mode="both" также предоставляет встроенное дополнение. mode="inline" сохраняет все элементы и предоставляет встроенное дополнение; mode="none" сохраняет все элементы без встроенного дополнения. readOnly не позволяет встроенному дополнению изменять поле ввода.
Структура
Размещайте связанные части внутри смонтированногоAutocomplete.Root. Компонуйте назначение портала, оболочку позиционирования и содержимое отдельно. InputGroup при необходимости группирует поле ввода с соседними элементами управления и привязывает всплывающее окно к этой группе.
Отображаемые части сохраняют нативные атрибуты, обработчики, ссылки, зависящие от состояния
className и style, а также композицию render элемента/функции из установленного API Base UI. Нативные свойства и ссылки нацелены на собственный элемент части. Пользовательские компоненты должны перенаправлять предоставленные свойства и ссылки. Публичные свойства частей и типы состояния экспортируются из twenty-ui/primitives/input вместе с действиями Root и типами сведений о событиях изменения/выделения.
Autocomplete.useFilter() предоставляет учитывающее локаль сопоставление contains, startsWith и endsWith. Autocomplete.useFilteredItems\<TItem>() считывает внутренне отфильтрованную коллекцию в Root. Считайте этот результат доступным только для чтения.
Объектные и сгруппированные элементы
Элементы могут быть строками или произвольными объектами. ИспользуйтеitemToStringValue, чтобы предоставить текст для фильтрации, дополнения и отправки формы. Объекты в виде { value, label } автоматически используют свою метку. Отображайте то же значение элемента, что предоставляется через Root; специальная для Twenty структура элемента или свойство равенства выбора не требуются. Autocomplete управляет текстовым вводом, а не отдельным значением выбранного объекта.
Для сгруппированных данных передавайте группы с массивом items. Root сохраняет тип элемента для itemToStringValue и onItemHighlighted. Отображайте отфильтрованные дочерние элементы каждой группы через Group и Collection:
Item.startIcon, Item.endIcon и Item.description предоставляют вспомогательное содержимое. Компонуйте Trigger и Clear с Twenty UI Button через render. Icon может содержать значок из twenty-ui/icon. Сохраняйте Status и Empty смонтированными при обновлении их дочерних элементов, чтобы программы чтения с экрана могли объявлять об изменениях.
Внешняя фильтрация и серверные предложения
ИспользуйтеfilteredItems, когда фильтрацией управляет ваше приложение. Он должен сохранять плоскую или сгруппированную структуру items. filter принимает пользовательскую функцию сопоставления; filter={null} отключает внутреннюю фильтрацию для результатов, уже отфильтрованных сервером.
open независимо, чтобы ответ мог открыть предложения, пока поле ввода остаётся в фокусе. Смонтированный Status может объявлять о загрузке; обновляйте Empty, когда завершённый ответ не содержит результатов. Родительский компонент управляет устранением дребезга, отменой запросов и защитой от устаревших ответов.
onValueChange и onOpenChange получают сведения о событиях из исходного компонента, включая reason, нативный event, trigger, cancel() и allowPropagation(). Управляемые вызывающие компоненты решают, какие запрошенные обновления применять. Например, игнорируйте изменение значения escape-key, чтобы сохранить серверный запрос, или игнорируйте открытие input-change до поступления результатов. onItemHighlighted получает исходный типизированный элемент и причину его выделения. Отмена сохраняет семантику установленного Base UI; она не заменяет политику управляемого состояния приложения.
Композиция ввода и нативные формы
Input принимает size="sm" или size="md" и использует те же стили, что и Input. Компонуйте его с существующим полем ввода, используя render. Составной элемент управления затем сам определяет свой внешний вид: Input не добавляет стили Input и игнорирует size, но по-прежнему передаёт ваши className, нативные атрибуты, обработчики, ref и атрибуты состояния. Передайте их фактическому элементу ввода. Отрисуйте Input Twenty, чтобы сохранить стандартный внешний вид.
InputGroup предоставляет компоновку и якорь, не добавляя границы поля ввода. Он может содержать чипы или отрисовывать существующую обёртку. Используйте InputGroup через его свойство render, когда всей группе требуется стилизация ввода, как в примере с предложениями сгруппированных объектов. Input без render внутри него убирает собственную границу. Добавьте полю ввода доступную метку или скомпонуйте его с Field.
Root сохраняет исходные name, form, disabled, readOnly и поведение нативной формы. Нативные атрибуты и ссылка Input нацелены на его input. submitOnItemClick включает отправку формы при выборе предложения; по умолчанию форма не отправляется.
Input сохраняет нативную обработку IME из Base UI, включая события композиции и защиту подтверждения с клавиатуры.
Установленная версия Base UI сохраняет неуправляемый запрос при нативном сбросе формы. Для управляемого запроса обрабатывайте onReset формы и восстанавливайте начальное значение приложения.
Размещение, назначение портала и закрытие
Positioner по умолчанию использует side="bottom", align="start" и sideOffset={8}. Он сохраняет контракт якоря и позиционирования установленного Base UI, включая якоря в виде элемента/ссылки/функции/виртуального элемента, функциональные смещения, positionMethod, collisionBoundary, collisionPadding, collisionAvoidance, arrowPadding, sticky и disableAnchorTracking. Настраивайте их в Positioner. DirectionProvider управляет логическим размещением и направлением DOM.
Popup использует ширину якоря в качестве минимальной ширины. Задайте его width, чтобы указать фиксированную ширину содержимого. Его нативные свойства, стили, композиция рендеринга и ссылка нацелены на элемент содержимого независимо от Positioner и Portal. initialFocus и finalFocus Popup сохраняют исходные параметры фокуса. По умолчанию предложения сохраняют фокус в поле ввода.
Настраивайте container и keepMounted в Portal. При отсутствии container используется ближайшее назначение ThemeProvider с областью действия, затем родительский портал Base UI или тело документа. Явный null ожидает предоставления container без рендеринга. Назначения Element, ShadowRoot и ref передаются в Base UI. Неразрешённый ref сохраняет резервный вариант Base UI: родительский портал или body.
Назначение с областью действия по умолчанию сохраняет свои токены CSS и цветовую схему. Явное назначение наследует CSS из своей фактической области DOM, поэтому разместите его в предполагаемой области темы или предоставьте там эти стили. Контекст React и направление остаются доступными через порталы. Целевым элементам ShadowRoot нужны CSS библиотеки и стили темы в этом теневом дереве.
Клавиши со стрелками изменяют выделенный элемент, пока поле ввода сохраняет фокус. Enter выбирает его; Escape и взаимодействие вне компонента запрашивают закрытие с использованием исходной семантики. Нажатие вне компонента может активировать целевой элемент управления. Средства выбора более высокого уровня могут использовать другую политику активации в своём адаптере. Вызовите event.preventBaseUIHandler() в onKeyDown Input, чтобы пропустить встроенный обработчик для клавиши, которую вы обрабатываете самостоятельно. Также используйте event.preventDefault(), когда подавляете нативное действие браузера.
Root.inline с open отображает предложения без сборки всплывающего окна. Встроенные элементы сохраняют свои обратные вызовы выбора onClick, но установленный исходный компонент автоматически заполняет поле ввода только при наличии Popup. Обрабатывайте Item.onClick, когда встроенный выбор должен обновлять ваш управляемый текст. Root.grid и Row поддерживают навигацию по сетке. Эти режимы сохраняют API исходной коллекции и рендеринга.
Миграция
Оберните Popup вAutocomplete.Positioner и Autocomplete.Portal. Positioner требует контекст Portal; встроенные предложения пропускают всю сборку всплывающего окна. Перенесите свойства размещения, якоря и коллизий из Popup в Positioner. Перенесите container и конфигурацию монтирования в Portal. Сохраняйте ширину, стили содержимого, нативные свойства, обработчики и ссылки в Popup. Используйте явный дочерний элемент Arrow для стрелки.
Внутри фронтальных компонентов сохраняйте существующую политику портала с областью действия. Этот API не расширяет назначения порталов рендерера, а также возможности работы с геометрией, прокруткой и закрытием; эти возможности рендерера имеют отдельное управление. Адаптеры средств выбора для production сохраняют свои преднамеренные рабочие процессы активации.
Свойства
Справочник создаётся из публичных типов компонентов. Нативные атрибуты, доступные имена и обработчики событий также принимаются в отображаемых частях.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. CallpreventUnmountOnClose()inonOpenChangefirst, otherwise the autocomplete completes closing on its own. Whether it leaves the DOM is decided bykeepMountedon 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>.
boolean
default:"false"
Determines if the popup enters a modal state when open.
true: user interaction is limited to the popup: document page scroll is locked and pointer interactions on outside elements are disabled.false: user interaction with the rest of the document is allowed.
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 aMouseEventrather than aPointerEvent.'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.
HTMLElement | ShadowRoot | RefObject<HTMLElement | ShadowRoot | null> | null
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 propertieswidthandheight.data.positioner: the dimensions of the positioner element with propertieswidthandheight.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.
Element | VirtualElement | RefObject<Element | null> | (() => Element | VirtualElement | null) | null
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 (topandbottom, orleftandright).'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 swapstartandendwhen 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 (topbeforebottom, orleftbeforerightin LTR).'end': allow perpendicular fallback and try the logical end side first (bottombeforetop, orrightbeforeleftin LTR).'none': do not fallback to the perpendicular axis.
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."bottom" | "inline-end" | "inline-start" | "left" | "right" | "top"
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.
Autocomplete.Popup
string | ((state: ComboboxPopupState) => string | undefined)
CSS class applied to the element, or a function that
returns a class based on the component’s state.
boolean | RefObject<HTMLElement | null> | ((closeType: InteractionType) => boolean | void | HTMLElement | null)
Determines the element to focus when the popup is closed.
false: Do not move focus.true: Move focus based on the default behavior (trigger or previously focused element).RefObject: Move focus to the ref element.function: Called with the interaction type (mouse,touch,pen, orkeyboard). Return an element to focus,trueto use the default behavior, orfalse/undefinedto do nothing.
boolean | RefObject<HTMLElement | null> | ((openType: InteractionType) => boolean | void | HTMLElement | null)
Determines the element to focus when the popup is opened.
false: Do not move focus.true: Move focus based on the default behavior (first tabbable element or popup).RefObject: Move focus to the ref element.function: Called with the interaction type (mouse,touch,pen, orkeyboard). Return an element to focus,trueto use the default behavior, orfalse/undefinedto do nothing.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, ComboboxPopupState>
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: ComboboxPopupState) => CSSProperties | undefined)
Style applied to the element, or a function that
returns a style object based on the component’s state.
string | number
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.