Select
A common form component for choosing a predefined value in a dropdown menu.
View as MarkdownUsage guidelines
- Prefer Combobox for large lists: Select is not filterable, aside from basic keyboard typeahead functionality to find items by focusing and highlighting them. Prefer Combobox instead of Select when the number of items is sufficiently large to warrant filtering.
- Special positioning behavior: The select popup by default overlaps its trigger so the selected item’s text is aligned with the trigger’s value text. This behavior can be disabled or customized.
Anatomy
Import the component and assemble its parts:
import { Select } from '@base-ui-components/react/select';
<Select.Root>
<Select.Trigger>
<Select.Value />
<Select.Icon />
</Select.Trigger>
<Select.Portal>
<Select.Backdrop />
<Select.Positioner>
<Select.ScrollUpArrow />
<Select.Popup>
<Select.Arrow />
<Select.List>
<Select.Item>
<Select.ItemText />
<Select.ItemIndicator />
</Select.Item>
<Select.Separator />
<Select.Group>
<Select.GroupLabel />
</Select.Group>
</Select.List>
</Select.Popup>
<Select.ScrollDownArrow />
</Select.Positioner>
</Select.Portal>
</Select.Root>API reference
Root
Groups all parts of the select. Doesn’t render its own HTML element.
namestring
—
namestring
—- Name
- Description
Identifies the field when a form is submitted.
- Type
string | undefined
defaultValueUnion
null
defaultValueUnion
null
- Name
- Description
The uncontrolled value of the select when it’s initially rendered.
To render a controlled select, use the
valueprop instead.- Type
Value[] | Value | null | undefined- Default
null
valueValue[] | Value
—
valueValue[] | Value
—- Name
- Description
The value of the select. Use when controlled.
- Type
Value[] | Value | undefined
onValueChangefunction
—
onValueChangefunction
—- Name
- Description
Event handler called when the value of the select changes.
- Type
| (( value: Value[] | Value, eventDetails: Select.Root.ChangeEventDetails, ) => void) | (( value: Value[] | Value | any | null, eventDetails: Select.Root.ChangeEventDetails, ) => void) | undefined
defaultOpenboolean
false
defaultOpenboolean
false
- Name
- Description
Whether the select popup is initially open.
To render a controlled select popup, use the
openprop instead.- Type
boolean | undefined- Default
false
openboolean
—
openboolean
—- Name
- Description
Whether the select popup is currently open.
- Type
boolean | undefined
onOpenChangefunction
—
onOpenChangefunction
—- Name
- Description
Event handler called when the select popup is opened or closed.
- Type
| (( open: boolean, eventDetails: Select.Root.ChangeEventDetails, ) => void) | undefined
actionsRefRefObject<Select.Root.Actions>
—
actionsRefRefObject<Select.Root.Actions>
—- Name
- Description
A ref to imperative actions.
unmount: When specified, the select will not be unmounted when closed. Instead, theunmountfunction must be called to unmount the select manually. Useful when the select's animation is controlled by an external library.
- Type
React.RefObject<Select.Root.Actions> | undefined
isItemEqualToValue((itemValue: Value, value: Value) => boolean)
—
isItemEqualToValue((itemValue: Value, value: Value) => boolean)
—- Description
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.iscomparison.- Type
| ((itemValue: Value, value: Value) => boolean) | undefined
itemToStringLabel((itemValue: Value) => string)
—
itemToStringLabel((itemValue: Value) => string)
—- Description
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.- Type
((itemValue: Value) => string) | undefined
itemToStringValue((itemValue: Value) => string)
—
itemToStringValue((itemValue: Value) => string)
—- Description
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.- Type
((itemValue: Value) => string) | undefined
itemsUnion
—
itemsUnion
—- Name
- Description
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.- Type
| Record<string, ReactNode> | { label: ReactNode; value: Value }[] | undefined- Example
const items = { sans: 'Sans-serif', serif: 'Serif', mono: 'Monospace', cursive: 'Cursive', }; <Select.Root items={items} />
modalboolean
true
modalboolean
true
- Name
- Description
Determines if the select enters a modal state when open.
true: user interaction is limited to the select: document page scroll is locked and and pointer interactions on outside elements are disabled.false: user interaction with the rest of the document is allowed.
- Type
boolean | undefined- Default
true
multipleboolean | undefined
false
multipleboolean | undefined
false
- Name
- Description
Whether multiple items can be selected.
- Type
boolean | undefined- Default
false
onOpenChangeCompletefunction
—
onOpenChangeCompletefunction
—- Description
Event handler called after any animations complete when the select popup is opened or closed.
- Type
((open: boolean) => void) | undefined
disabledboolean
false
disabledboolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined- Default
false
readOnlyboolean
false
readOnlyboolean
false
- Name
- Description
Whether the user should be unable to choose a different option from the select popup.
- Type
boolean | undefined- Default
false
requiredboolean
false
requiredboolean
false
- Name
- Description
Whether the user must choose a value before submitting a form.
- Type
boolean | undefined- Default
false
inputRefRef<HTMLInputElement>
—
inputRefRef<HTMLInputElement>
—- Name
- Description
A ref to access the hidden input element.
- Type
React.Ref<HTMLInputElement> | undefined
idstring
—
idstring
—- Name
- Description
The id of the Select.
- Type
string | undefined
childrenReactNode
—
childrenReactNode
—- Name
- Type
React.ReactNode | undefined
Trigger
A button that opens the select popup.
Renders a <div> element.
nativeButtonboolean
false
nativeButtonboolean
false
- Name
- Description
Whether the component renders a native
<button>element when replacing it via therenderprop. Set totrueif the rendered element is a native button.- Type
boolean | undefined- Default
false
disabledboolean
—
disabledboolean
—- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined
childrenReactNode
—
childrenReactNode
—- Name
- Type
React.ReactNode
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Trigger.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Trigger.State, ) => ReactElement)
data-popup-open
Present when the corresponding select is open.
data-pressed
Present when the trigger is pressed.
data-disabled
Present when the select is disabled.
data-readonly
Present when the select is readonly.
data-required
Present when the select is required.
data-valid
Present when the select is in valid state (when wrapped in Field.Root).
data-invalid
Present when the select is in invalid state (when wrapped in Field.Root).
data-dirty
Present when the select's value has changed (when wrapped in Field.Root).
data-touched
Present when the select has been touched (when wrapped in Field.Root).
data-filled
Present when the select has a value (when wrapped in Field.Root).
data-focused
Present when the select trigger is focused (when wrapped in Field.Root).
Value
A text label of the currently selected item.
Renders a <span> element.
childrenReactNode | ((value: any) => ReactNode)
—
childrenReactNode | ((value: any) => ReactNode)
—- Name
- Description
Accepts a function that returns a
ReactNodeto format the selected value.- Type
React.ReactNode | ((value: any) => ReactNode)- Example
<Select.Value> {(value: string | null) => value ? labels[value] : 'No value'} </Select.Value>
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Value.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Value.State, ) => ReactElement)
Icon
An icon that indicates that the trigger button opens a select popup.
Renders a <span> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Icon.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Icon.State, ) => ReactElement)
data-popup-open
Present when the corresponding popup is open.
Backdrop
An overlay displayed beneath the menu popup.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Backdrop.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Backdrop.State, ) => ReactElement)
data-open
Present when the select is open.
data-closed
Present when the select is closed.
data-starting-style
Present when the select is animating in.
data-ending-style
Present when the select is animating out.
Portal
A portal element that moves the popup to a different part of the DOM.
By default, the portal element is appended to <body>.
Renders a <div> element.
containerUnion
—
containerUnion
—- Name
- Description
A parent element to render the portal element into.
- Type
| HTMLElement | ShadowRoot | React.RefObject<HTMLElement | ShadowRoot | null> | null | undefined
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Portal.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Portal.State, ) => ReactElement)
Positioner
Positions the select popup.
Renders a <div> element.
alignItemWithTriggerboolean
true
alignItemWithTriggerboolean
true
- Description
Whether the positioner overlaps the trigger so the selected item's text is aligned with the trigger's value text. This only applies to mouse input and is automatically disabled if there is not enough space.
- Type
boolean | undefined- Default
true
collisionAvoidanceCollisionAvoidance
—
collisionAvoidanceCollisionAvoidance
—- Description
Determines how to handle collisions when positioning the popup.
- Type
| { side?: 'none' | 'flip' align?: 'none' | 'shift' | 'flip' fallbackAxisSide?: 'none' | 'start' | 'end' } | { side?: 'none' | 'shift' align?: 'none' | 'shift' fallbackAxisSide?: 'none' | 'start' | 'end' } | undefined- Example
<Positioner collisionAvoidance={{ side: 'shift', align: 'shift', fallbackAxisSide: 'none', }} />
alignAlign
'center'
alignAlign
'center'
- Name
- Description
How to align the popup relative to the specified side.
- Type
'center' | 'start' | 'end' | undefined- Default
'center'
alignOffsetnumber | OffsetFunction
0
alignOffsetnumber | OffsetFunction
0
- Name
- Description
Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment.
The function takes a
dataobject 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.
- Type
| number | ((data: { side: Side align: Align anchor: { width: number; height: number } positioner: { width: number; height: number } }) => number) | undefined- Default
0- Example
<Positioner alignOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.width : anchor.height; }} />
sideSide
'bottom'
sideSide
'bottom'
- Name
- Description
Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
- Type
| 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start' | undefined- Default
'bottom'
sideOffsetnumber | OffsetFunction
0
sideOffsetnumber | OffsetFunction
0
- Name
- Description
Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment.
The function takes a
dataobject 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.
- Type
| number | ((data: { side: Side align: Align anchor: { width: number; height: number } positioner: { width: number; height: number } }) => number) | undefined- Default
0- Example
<Positioner sideOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.height : anchor.width; }} />
arrowPaddingnumber
5
arrowPaddingnumber
5
- Name
- Description
Minimum distance to maintain between the arrow and the edges of the popup.
Use it to prevent the arrow element from hanging out of the rounded corners of a popup.
- Type
number | undefined- Default
5
anchorUnion
—
anchorUnion
—- Name
- Description
An element to position the popup against. By default, the popup will be positioned against the trigger.
- Type
| Element | React.RefObject<Element | null> | VirtualElement | (() => Element | VirtualElement | null) | null | undefined
collisionBoundaryBoundary
'clipping-ancestors'
collisionBoundaryBoundary
'clipping-ancestors'
- Description
An element or a rectangle that delimits the area that the popup is confined to.
- Type
| Element | 'clipping-ancestors' | Element[] | Rect | undefined- Default
'clipping-ancestors'
collisionPaddingPadding
5
collisionPaddingPadding
5
- Name
- Description
Additional space to maintain from the edge of the collision boundary.
- Type
| { top?: number right?: number bottom?: number left?: number } | number | undefined- Default
5
stickyboolean
false
stickyboolean
false
- Name
- Description
Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
- Type
boolean | undefined- Default
false
positionMethod'fixed' | 'absolute'
'absolute'
positionMethod'fixed' | 'absolute'
'absolute'
- Name
- Description
Determines which CSS
positionproperty to use.- Type
'fixed' | 'absolute' | undefined- Default
'absolute'
trackAnchorboolean
true
trackAnchorboolean
true
- Name
- Description
Whether the popup tracks any layout shift of its positioning anchor.
- Type
boolean | undefined- Default
true
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Positioner.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Positioner.State, ) => ReactElement)
data-open
Present when the select popup is open.
data-closed
Present when the select popup is closed.
data-anchor-hidden
Present when the anchor is hidden.
data-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.
--anchor-height
The anchor's height.
--anchor-width
The anchor's width.
--available-height
The available height between the trigger and the edge of the viewport.
--available-width
The available width between the trigger and the edge of the viewport.
--transform-origin
The coordinates that this element is anchored to. Used for animations and transitions.
Popup
A container for the select list.
Renders a <div> element.
childrenReactNode
—
childrenReactNode
—- Name
- Type
React.ReactNode
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Popup.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Popup.State, ) => ReactElement)
data-open
Present when the select is open.
data-closed
Present when the select is closed.
data-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.
data-starting-style
Present when the select is animating in.
data-ending-style
Present when the select is animating out.
List
A container for the select items.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.List.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.List.State, ) => ReactElement)
Arrow
Displays an element positioned against the select popup anchor.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Arrow.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Arrow.State, ) => ReactElement)
data-open
Present when the select popup is open.
data-closed
Present when the select popup is closed.
data-uncentered
Present when the select arrow is uncentered.
data-anchor-hidden
Present when the anchor is hidden.
data-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.
Item
An individual option in the select popup.
Renders a <div> element.
labelstring
—
labelstring
—- Name
- Description
Specifies the text label to use when the item is matched during keyboard text navigation.
Defaults to the item text content if not provided.
- Type
string | undefined
valueany
null
valueany
null
- Name
- Description
A unique value that identifies this select item.
- Type
any- Default
null
nativeButtonboolean
false
nativeButtonboolean
false
- Name
- Description
Whether the component renders a native
<button>element when replacing it via therenderprop. Set totrueif the rendered element is a native button.- Type
boolean | undefined- Default
false
disabledboolean
false
disabledboolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean | undefined- Default
false
childrenReactNode
—
childrenReactNode
—- Name
- Type
React.ReactNode
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Item.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Item.State, ) => ReactElement)
data-selected
Present when the select item is selected.
data-highlighted
Present when the select item is highlighted.
data-disabled
Present when the select item is disabled.
ItemText
A text label of the select item.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.ItemText.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.ItemText.State, ) => ReactElement)
ItemIndicator
Indicates whether the select item is selected.
Renders a <span> element.
childrenReactNode
—
childrenReactNode
—- Name
- Type
React.ReactNode
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
| string | ((state: Select.ItemIndicator.State) => string)
keepMountedboolean
—
keepMountedboolean
—- Name
- Description
Whether to keep the HTML element in the DOM when the item is not selected.
- Type
boolean | undefined
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.ItemIndicator.State, ) => ReactElement)
Group
Groups related select items with the corresponding label.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.Group.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.Group.State, ) => ReactElement)
GroupLabel
An accessible label that is automatically associated with its parent group.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Select.GroupLabel.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.GroupLabel.State, ) => ReactElement)
ScrollUpArrow
An element that scrolls the select popup up when hovered. Does not render when using touch input.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
| string | ((state: Select.ScrollUpArrow.State) => string)
keepMountedboolean
false
keepMountedboolean
false
- Name
- Description
Whether to keep the HTML element in the DOM while the select popup is not scrollable.
- Type
boolean | undefined- Default
false
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.ScrollUpArrow.State, ) => ReactElement)
data-direction
Indicates the direction of the scroll arrow.
data-side
Indicates which side the popup is positioned relative to the trigger.
data-visible
Present when the scroll arrow is visible.
data-starting-style
Present when the scroll arrow is animating in.
data-ending-style
Present when the scroll arrow is animating out.
ScrollDownArrow
An element that scrolls the select popup down when hovered. Does not render when using touch input.
Renders a <div> element.
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
| string | ((state: Select.ScrollDownArrow.State) => string)
keepMountedboolean
false
keepMountedboolean
false
- Name
- Description
Whether to keep the HTML element in the DOM while the select popup is not scrollable.
- Type
boolean | undefined- Default
false
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Select.ScrollDownArrow.State, ) => ReactElement)
data-direction
Indicates the direction of the scroll arrow.
data-side
Indicates which side the popup is positioned relative to the trigger.
data-visible
Present when the scroll arrow is visible.
data-starting-style
Present when the scroll arrow is animating in.
data-ending-style
Present when the scroll arrow is animating out.
Separator
A separator element accessible to screen readers.
Renders a <div> element.
orientationOrientation
'horizontal'
orientationOrientation
'horizontal'
- Name
- Description
The orientation of the separator.
- Type
'horizontal' | 'vertical' | undefined- Default
'horizontal'
classNamestring | function
—
classNamestring | function
—- Name
- Description
CSS class applied to the element, or a function that returns a class based on the component’s state.
- Type
string | ((state: Separator.State) => string)
renderReactElement | function
—
renderReactElement | function
—- Name
- Description
Allows you to replace the component’s HTML element with a different tag, or compose it with another component.
Accepts a
ReactElementor a function that returns the element to render.- Type
| ReactElement | (( props: HTMLProps, state: Separator.State, ) => ReactElement)
Positioning
<Select.Positioner> has a special prop called alignItemWithTrigger which causes the positioning to act differently by default from other Positioner components.
The prop makes the select popup overlap the trigger so the selected item’s text is aligned with the trigger’s value text.
For styling, data-side is "none" on the .Popup and .Positioner parts when the mode is active.
To prevent the select popup from overlapping its trigger, set the alignItemWithTrigger prop to false.
When set to true (its default) there are a few important points to note about its behavior:
- Interaction type dependent: For UX reasons, the
alignItemWithTriggerpositioning mode is disabled if touch was the pointer type used to open the popup. - Viewport space dependent: There must be enough space in the viewport to align the selected item’s text with the trigger’s value text without causing the popup to be too vertically small — otherwise, it falls back to the default positioning mode.
This can be customized by setting
min-heighton the<Select.Positioner>element; a smaller value will fallback less often. Additionally, the trigger must be at least 20px from the edges of the top and bottom of the viewport, or it will also fall back. - Other positioning props are ignored: Props like
sideoralignhave no effect unless the prop is set tofalseor when in fallback mode.
Formatting the value
By default, the <Select.Value> component renders the raw value.
Passing the items prop to <Select.Root> instead renders the matching label for the rendered value:
const items = [
{ value: null, label: 'Select theme' },
{ value: 'system', label: 'System default' },
{ value: 'light', label: 'Light' },
{ value: 'dark', label: 'Dark' },
];
<Select.Root items={items}>
<Select.Value />
</Select.Root>A function can also be passed as the children prop of <Select.Value> to render a formatted value:
const items = {
monospace: 'Monospace',
serif: 'Serif',
'san-serif': 'Sans-serif',
};
<Select.Value>
{(value: keyof typeof items) => (
<span style={{ fontFamily: value }}>
{items[value]}
</span>
)}
</Select.Value>To avoid lookup, object values for each item can also be used.
Examples
Multiple selection
Add the multiple prop to the <Select.Root> component to allow multiple selections.
Object values
Select items can use objects as values instead of primitives.
This lets you access the full object in custom render functions, and can avoid needing to specify items for lookup.