Saltar al contenido principal

Resumen

Use Select para un valor de formulario elegido de una lista. Dropdown sigue siendo la API principal de nivel superior para menús, selectores, paneles y páginas que combinan esos Workflows.

”Uso”

Estado no controlado.

Usa defaultValue para establecer la prioridad inicial. El selector gestiona los cambios de selección posteriores.
Proporcione items en Root para que Value muestre la etiqueta del elemento seleccionado; sin ellos, el activador muestra el valor sin procesar. El valor seleccionado puede ser null cuando no hay nada seleccionado.

Anatomía

Compón las partes públicas dentro de Select.Root. Trigger e Item procesan únicamente sus elementos secundarios. Añade Icon, ItemText e ItemIndicator explícitamente cuando quieras el chevrón, la etiqueta y la marca de verificación predeterminados.
Portal, List, Backdrop, las flechas y los indicadores son opcionales. Usa Positioner alrededor de Popup para el posicionamiento, incluso cuando representes la ventana emergente en línea sin un portal.

Estado controlado

Pasa value y actualízalo con onValueChange para gestionar la misma prioridad en el estado de React. La devolución de llamada recibe el siguiente valor y los detalles del evento.

Selección múltiple

Con multiple, el valor es una matriz. Usa defaultValue={['en']} en lugar de value y onValueChange para una selección múltiple no controlada. Los tipos genéricos de raíz representan el valor de la opción y si la selección múltiple está habilitada.

Estado abierto

La selección y la visibilidad de la ventana emergente son independientes. Los ejemplos anteriores dejan la visibilidad de la ventana emergente sin controlar. Seleccionar un único valor cierra la ventana emergente; la selección múltiple la mantiene abierta. Usa defaultOpen para establecer su visibilidad inicial; su valor predeterminado es false. Pasa open y actualízalo con onOpenChange para controlar la visibilidad. Este ejemplo controla la ventana emergente y deja la prioridad seleccionada sin controlar.

Combinar con un campo

Envuelve el selector en Field.Root para asociar su activador con una etiqueta visible y texto de ayuda. El campo gestiona el etiquetado y la validación; el selector mantiene su propio estado de selección y ventana emergente.

Composición de elementos

Compón contenido arbitrario dentro de Item. Coloca la etiqueta buscable en ItemText; el contenido adicional no se convierte en su etiqueta de búsqueda anticipada. Proporciona elementos secundarios a Icon o ItemIndicator para reemplazar sus iconos predeterminados, u omite esas partes por completo.
Todas las partes que representan elementos aceptan atributos nativos, referencias y las API de composición render, className y style de Base UI. Por ejemplo, usa render={<Button />} en Trigger para componerlo con un botón de Twenty UI. Para un elemento de representación que no sea un botón, establece también nativeButton={false}.

Ubicación

Establece size="sm" o size="md" en Trigger. La ubicación pertenece a Positioner; el destino del portal pertenece a Portal. Positioner conserva los valores predeterminados de Base UI: side="bottom", align="center", sideOffset={0} y alignItemWithTrigger={true}. La alineación del elemento seleccionado se aplica a la entrada mediante puntero cuando hay suficiente espacio. Establece alignItemWithTrigger={false} para usar un posicionamiento anclado de forma coherente. Los ejemplos anteriores eligen explícitamente align="start" y sideOffset={8}.
Positioner también admite anclas virtuales, funciones de desplazamiento, arrowPadding y disableAnchorTracking. Portal usa el contenedor del portal del tema, a menos que proporciones container. Un container={null} explícito espera hasta que ese contenedor esté disponible.

Formularios nativos y detalles de las devoluciones de llamada

Establece name en Root para incluir el valor seleccionado en FormData. La selección múltiple envía una entrada por cada valor seleccionado. form asocia la entrada oculta con un formulario externo, y inputRef proporciona acceso a esa entrada. required, disabled y autoComplete conservan el comportamiento de formulario nativo de Base UI. onValueChange y onOpenChange reciben el siguiente estado y los detalles del evento ascendente, incluidos reason, el event nativo, cancel() y allowPropagation(). Llamar a cancel() impide el cambio de estado interno correspondiente. Las raíces controladas aún requieren que actualices value u open.
Los tipos genéricos de raíz representan el valor de la opción y si la selección múltiple está habilitada. Los valores de objeto admiten itemToStringLabel, itemToStringValue e isItemEqualToValue. Usa null para una selección única vacía y un arreglo vacío para una selección múltiple vacía.

Teclado

Los usuarios de teclado pueden abrir la lista desde el activador, navegar por las opciones con las teclas de flecha y escribir para encontrar una opción. Inicio y Fin saltan a la primera y la última opción. Intro selecciona una opción; Escape descarta la ventana emergente y restaura el foco del disparador. La selección múltiple mantiene abierta la ventana emergente mientras se alternan las opciones. Etiqueta el disparador con Select.Label, un nombre accesible o Field. Un marcador de posición por sí solo no da nombre al control.

”Props”

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

Select.Root

RefObject<SelectRootActions | null>
A ref to imperative actions.
  • unmount: Ends the closing phase of the select after an externally controlled closing animation finishes. Call preventUnmountOnClose() in onOpenChange first, otherwise the select completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.
  • close: Closes the select imperatively when called.
string
Provides a hint to the browser for autofill.
ReactNode
Select parts sharing selection, open state and accessible relationships. Root renders no DOM node.
boolean
predeterminado:"false"
Whether the select popup is initially open.To render a controlled select popup, use the open prop instead.
SelectInputValue<Value, Multiple> | null
The uncontrolled value of the select when it’s initially rendered.To render a controlled select, use the value prop instead.
boolean
predeterminado:"false"
Whether the component should ignore user interaction.
string
Identifies the form that owns the hidden input. Useful when the select is rendered outside the form.
boolean
predeterminado:"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 Select.
Ref<HTMLInputElement>
Ref to the native hidden input used for form submission.
((itemValue: Value, value: Value) => boolean)
Custom comparison logic used to determine if a select item value matches the current selected value. Useful when item values are objects without matching referentially. Defaults to Object.is comparison.
Record<string, ReactNode> | readonly { label: ReactNode; value: any; }[] | readonly Group<any>[]
Data structure of the items rendered in the select popup. When specified, <Select.Value> renders the label of the selected item instead of the raw value.
((itemValue: Value) => string)
When the item values are objects (<Select.Item value={object}>), this function converts the object value to a string representation for display in the trigger. If the shape of the object is { value, label }, the label will be used automatically without needing to specify this prop.
((itemValue: Value) => string)
When the item values are objects (<Select.Item value={object}>), this function converts the object value to a string representation for form submission. If the shape of the object is { value, label }, the value will be used automatically without needing to specify this prop.
boolean
predeterminado:"true"
Determines if the select enters a modal state when open.
  • true: user interaction is limited to the select: 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.
boolean
predeterminado:"false"
Whether multiple items can be selected.
string
Identifies the field when a form is submitted.
((open: boolean, eventDetails: SelectRootOpenChangeEventDetails) => void)
Receives the requested open state and unchanged Base UI event details.
((open: boolean) => void)
Event handler called after any animations complete when the select popup is opened or closed.
((value: SelectOutputValue<Value, Multiple> | (Multiple extends true ? never : null), eventDetails: SelectRootChangeEventDetails) => void)
Receives the requested generic value and unchanged Base UI event details, including reason, event and cancel(). Multiple selection receives an array; a cleared single value is null.
boolean
Whether the select popup is currently open.
boolean
predeterminado:"false"
Whether the user should be unable to choose a different option from the select popup.
boolean
predeterminado:"false"
Whether the user must choose a value before submitting a form.
SelectInputValue<Value, Multiple> | null
The value of the select. Use when controlled.

Select.Label

string | ((state: FieldRootState) => 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, FieldRootState>
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: FieldRootState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Trigger

ReactNode
Trigger content rendered as supplied. Compose Value and Icon explicitly.
string | ((state: SelectTriggerState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
boolean
Whether the component should ignore user interaction.
boolean
predeterminado:"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>).
Ref<HTMLButtonElement>
Ref to the rendered trigger element, a button by default.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectTriggerState>
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"
predeterminado:"md"
Visual size of the trigger. Defaults to md.
CSSProperties | ((state: SelectTriggerState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Value

ReactNode | ((value: any) => ReactNode)
Accepts a function that returns a ReactNode to format the selected value. Treat the value as read-only: in multiple mode it may be a shared frozen array when nothing is selected.
string | ((state: SelectValueState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
ReactNode
The placeholder value to display when no value is selected. This is overridden by children if specified, or by a null item’s label in items.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectValueState>
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: SelectValueState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Icon

ReactNode
predeterminado:"<IconChevronDown />"
Trigger icon content. Defaults to the Twenty chevron; explicit children replace it.
string | ((state: SelectIconState) => 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, SelectIconState>
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: SelectIconState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Portal

string | ((state: SelectPortalState) => 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. Defaults to the current theme container, then the document body. Explicit null waits for a container before mounting.
Ref<HTMLDivElement>
Ref to the portal div. Native props and render apply to this element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectPortalState>
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: SelectPortalState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Backdrop

string | ((state: SelectBackdropState) => 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, SelectBackdropState>
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: SelectBackdropState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Positioner

"center" | "end" | "start"
predeterminado:"center"
How to align the popup relative to the specified side.
boolean
predeterminado:"true"
Uses the upstream selected-item alignment by default. Set false to use side, align and offsets without overlapping the trigger.
number | OffsetFunction
predeterminado:"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.
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
predeterminado:"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: SelectPositionerState) => 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
predeterminado:"clipping-ancestors"
An element or a rectangle that delimits the area that the popup is confined to.
Padding
predeterminado:"5"
Additional space to maintain from the edge of the collision boundary.
boolean
predeterminado:"false"
Whether to disable the popup from tracking any layout shift of its positioning anchor.
"absolute" | "fixed"
predeterminado:"absolute"
Determines which CSS position property to use.
Ref<HTMLDivElement>
Ref to the positioning div. Native props, styles and render apply to this element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectPositionerState>
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"
predeterminado:"bottom"
Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
number | OffsetFunction
predeterminado:"0"
Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment.The function takes a data object parameter with the following properties:
  • data.anchor: the dimensions of the anchor element with properties width and height.
  • data.positioner: the dimensions of the positioner element with properties width and height.
  • data.side: which side of the anchor element the positioner is aligned against.
  • data.align: how the positioner is aligned relative to the specified side.
boolean
predeterminado:"false"
Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
CSSProperties | ((state: SelectPositionerState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Popup

ReactNode
Popup content rendered as supplied. Compose inside Positioner and choose Portal separately.
string | ((state: SelectPopupState) => 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 select 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.
Ref<HTMLDivElement>
Ref to the popup div. Native props, styles and render apply to this element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectPopupState>
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: SelectPopupState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.List

string | ((state: SelectListState) => 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, SelectListState>
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: SelectListState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Item

ReactNode
Option content rendered as supplied. Compose ItemText and an optional ItemIndicator explicitly.
string | ((state: SelectItemState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
boolean
predeterminado:"false"
Whether the component should ignore user interaction.
string
Specifies the text label to use when the item is matched during keyboard text navigation.Defaults to the item text content if not provided.
boolean
predeterminado:"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.
Ref<HTMLElement>
Ref to the rendered option element. Native props and render apply to this element.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectItemState>
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: SelectItemState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.
any
predeterminado:"null"
A unique value that identifies this select item.

Select.ItemIndicator

ReactNode
Selected indicator content. Defaults to the Twenty check icon; explicit children replace it.
string | ((state: SelectItemIndicatorState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
boolean
Whether to keep the HTML element in the DOM when the item is not selected.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectItemIndicatorState>
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: SelectItemIndicatorState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.ItemText

string | ((state: SelectItemTextState) => 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, SelectItemTextState>
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: SelectItemTextState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Arrow

string | ((state: SelectArrowState) => 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, SelectArrowState>
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: SelectArrowState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.ScrollDownArrow

string | ((state: SelectScrollDownArrowState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
boolean
predeterminado:"false"
Whether to keep the HTML element in the DOM while the select popup is not scrollable.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectScrollDownArrowState>
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: SelectScrollDownArrowState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.ScrollUpArrow

string | ((state: SelectScrollUpArrowState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
boolean
predeterminado:"false"
Whether to keep the HTML element in the DOM while the select popup is not scrollable.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectScrollUpArrowState>
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: SelectScrollUpArrowState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Group

string | ((state: SelectGroupState) => 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, SelectGroupState>
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: SelectGroupState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.GroupLabel

string | ((state: SelectGroupLabelState) => 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, SelectGroupLabelState>
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: SelectGroupLabelState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.

Select.Separator

string | ((state: SelectSeparatorState) => string | undefined)
CSS class applied to the element, or a function that returns a class based on the component’s state.
"horizontal" | "vertical"
predeterminado:"horizontal"
The orientation of the separator.
ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, SelectSeparatorState>
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: SelectSeparatorState) => CSSProperties | undefined)
Style applied to the element, or a function that returns a style object based on the component’s state.