Select
A common form component for choosing a predefined value in a dropdown menu.
View as MarkdownAnatomy
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.Item>
<Select.ItemText />
<Select.ItemIndicator />
</Select.Item>
<Select.Separator />
<Select.Group>
<Select.GroupLabel />
</Select.Group>
</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.
name
string
string
- Name
- Description
Identifies the field when a form is submitted.
- Type
string
defaultValue
Union
(default: null
)
Union
null
- Name
- Description
The uncontrolled value of the select when it’s initially rendered.
To render a controlled select, use the
value
prop instead.- Type
Value[] | Value | null
- Default
null
value
Union
Union
- Name
- Description
The value of the select.
- Type
Value[] | Value | null
onValueChange
function
function
- Name
- Description
Callback fired when the value of the select changes. Use when controlled.
- Type
((value: Value[] | Value, event: Event | undefined) => void)
defaultOpen
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the select menu is initially open.
To render a controlled select menu, use the
open
prop instead.- Type
boolean
- Default
false
open
boolean
boolean
- Name
- Description
Whether the select menu is currently open.
- Type
boolean
onOpenChange
function
function
- Name
- Description
Event handler called when the select menu is opened or closed.
- Type
((open: boolean, event: Event | undefined, reason: Select.Root.OpenChangeReason | undefined) => void)
actionsRef
RefObject<Select.Root.Actions>
RefObject<Select.Root.Actions>
- Name
- Description
A ref to imperative actions.
unmount
: When specified, the select will not be unmounted when closed. Instead, theunmount
function must be called to unmount the select manually. Useful when the select's animation is controlled by an external library.
- Type
RefObject<Select.Root.Actions>
items
Union
Union
- Name
- Description
Data structure of the items rendered in the select menu. When specified,
<Select.Value>
renders the label of the selected item instead of the raw value.- Type
| Record<string, ReactNode>
| ({ label: ReactNode, value: Value })[]
modal
boolean
(default: true
)
boolean
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
- Default
true
multiple
boolean | undefined
(default: false
)
boolean | undefined
false
- Name
- Description
Whether multiple items can be selected.
- Type
boolean | undefined
- Default
false
onOpenChangeComplete
function
function
- Description
Event handler called after any animations complete when the select menu is opened or closed.
- Type
((open: boolean) => void)
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean
- Default
false
readOnly
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the user should be unable to choose a different option from the select menu.
- Type
boolean
- Default
false
required
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the user must choose a value before submitting a form.
- Type
boolean
- Default
false
inputRef
Ref<HTMLInputElement>
Ref<HTMLInputElement>
- Name
- Description
A ref to access the hidden input element.
- Type
Ref<HTMLInputElement>
id
string
string
- Name
- Description
The id of the Select.
- Type
string
children
ReactNode
ReactNode
- Name
- Type
ReactNode
Trigger
A button that opens the select menu.
Renders a <div>
element.
nativeButton
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component renders a native
<button>
element when replacing it via therender
prop. Set totrue
if the rendered element is a native button.- Type
boolean
- Default
false
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean
- Default
false
children
ReactNode
ReactNode
- Name
- Type
ReactNode
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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.
children
ReactNode | ((value: any) => ReactNode)
ReactNode | ((value: any) => ReactNode)
- Name
- Description
Accepts a function that returns a
ReactNode
to format the selected value.- Type
ReactNode | ((value: any) => ReactNode)
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Select.Value.State) => ReactElement)
Icon
An icon that indicates that the trigger button opens a select menu.
Renders a <span>
element.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Select.Icon.State) => ReactElement)
Backdrop
An overlay displayed beneath the menu popup.
Renders a <div>
element.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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>
.
container
Union
Union
- Name
- Description
A parent element to render the portal element into.
- Type
| HTMLElement
| ShadowRoot
| RefObject<HTMLElement
| ShadowRoot
| null>
| null
children
ReactNode
ReactNode
- Name
- Type
ReactNode
Positioner
Positions the select menu popup.
Renders a <div>
element.
alignItemWithTrigger
boolean
(default: true
)
boolean
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
- Default
true
collisionAvoidance
CollisionAvoidance
CollisionAvoidance
- Description
Determines how to handle collisions when positioning the popup.
- Type
CollisionAvoidance
align
Union
(default: 'center'
)
Union
'center'
- Name
- Description
How to align the popup relative to the specified side.
- Type
'center' | 'start' | 'end'
- Default
'center'
alignOffset
number | OffsetFunction
(default: 0
)
number | 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.
data.anchor
: the dimensions of the anchor element with propertieswidth
andheight
.data.positioner
: the dimensions of the positioner element with propertieswidth
andheight
.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 | OffsetFunction
- Default
0
side
Side
(default: 'bottom'
)
Side
'bottom'
- Name
- Description
Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
- Type
Side
- Default
'bottom'
sideOffset
number | OffsetFunction
(default: 0
)
number | 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.
data.anchor
: the dimensions of the anchor element with propertieswidth
andheight
.data.positioner
: the dimensions of the positioner element with propertieswidth
andheight
.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 | OffsetFunction
- Default
0
arrowPadding
number
(default: 5
)
number
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
- Default
5
anchor
Union
Union
- Name
- Description
An element to position the popup against. By default, the popup will be positioned against the trigger.
- Type
| Element
| RefObject<Element
| null>
| VirtualElement
| (() => Element | VirtualElement | null)
| null
collisionBoundary
Boundary
(default: 'clipping-ancestors'
)
Boundary
'clipping-ancestors'
- Description
An element or a rectangle that delimits the area that the popup is confined to.
- Type
Boundary
- Default
'clipping-ancestors'
collisionPadding
Padding
(default: 5
)
Padding
5
- Name
- Description
Additional space to maintain from the edge of the collision boundary.
- Type
Padding
- Default
5
sticky
boolean
(default: false
)
boolean
false
- Name
- Description
Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
- Type
boolean
- Default
false
positionMethod
'fixed' | 'absolute'
(default: 'absolute'
)
'fixed' | 'absolute'
'absolute'
- Name
- Description
Determines which CSS
position
property to use.- Type
'fixed' | 'absolute'
- Default
'absolute'
trackAnchor
boolean
(default: true
)
boolean
true
- Name
- Description
Whether the popup tracks any layout shift of its positioning anchor.
- Type
boolean
- Default
true
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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 items.
Renders a <div>
element.
id
string
string
- Name
- Type
string
children
ReactNode
ReactNode
- Name
- Type
ReactNode
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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.
Arrow
Displays an element positioned against the select menu anchor.
Renders a <div>
element.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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 menu.
Renders a <div>
element.
label
string
string
- Name
- Description
Overrides the text label to use on the trigger when this item is selected and when the item is matched during keyboard text navigation.
- Type
string
value
any
(default: null
)
any
null
- Name
- Description
A unique value that identifies this select item.
- Type
any
- Default
null
nativeButton
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component renders a native
<button>
element when replacing it via therender
prop. Set totrue
if the rendered element is a native button.- Type
boolean
- Default
false
disabled
boolean
(default: false
)
boolean
false
- Name
- Description
Whether the component should ignore user interaction.
- Type
boolean
- Default
false
children
ReactNode
ReactNode
- Name
- Type
ReactNode
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Select.ItemText.State) => ReactElement)
ItemIndicator
Indicates whether the select item is selected.
Renders a <span>
element.
children
ReactNode
ReactNode
- Name
- Type
ReactNode
className
string | function
string | 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)
keepMounted
boolean
(default: false
)
boolean
false
- Name
- Description
Whether to keep the HTML element in the DOM when the item is not selected.
- Type
boolean
- Default
false
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Select.ItemIndicator.State) => ReactElement)
Group
Groups related select items with the corresponding label.
Renders a <div>
element.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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.
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Select.GroupLabel.State) => ReactElement)
ScrollUpArrow
An element that scrolls the select menu up when hovered.
Renders a <div>
element.
className
string | function
string | 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)
keepMounted
boolean
(default: false
)
boolean
false
- Name
- Description
Whether to keep the HTML element in the DOM while the select menu is not scrollable.
- Type
boolean
- Default
false
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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 menu down when hovered.
Renders a <div>
element.
className
string | function
string | 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)
keepMounted
boolean
(default: false
)
boolean
false
- Name
- Description
Whether to keep the HTML element in the DOM while the select menu is not scrollable.
- Type
boolean
- Default
false
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- 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.
orientation
Orientation
(default: 'horizontal'
)
Orientation
'horizontal'
- Name
- Description
The orientation of the separator.
- Type
Orientation
- Default
'horizontal'
className
string | function
string | 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)
render
ReactElement | function
ReactElement | function
- Name
- Description
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.- Type
| ReactElement
| ((props: HTMLProps, state: Separator.State) => ReactElement)
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>
const items = {
null: 'Select theme',
system: 'System default',
light: 'Light',
dark: '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>
Multiple selection
Add the multiple
prop to the Select.Root
component to allow multiple selections.