Select

A common form component for choosing a predefined value in a dropdown menu.

View as Markdown

Usage 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:

Anatomy

API reference

Root

Groups all parts of the select. Doesn’t render its own HTML element.

name

string

Name
Description

Identifies the field when a form is submitted.

Type
string | undefined
defaultValue

Union

null

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 | undefined
Default

null

value

Value[] | Value

Name
Description

The value of the select.

Type
Value[] | Value | undefined
onValueChange

function

Description

Callback fired when the value of the select changes. Use when controlled.

Type
| ((
    value: Value[] | Value,
    eventDetails: Select.Root.ChangeEventDetails,
  ) => void)
| undefined
defaultOpen

boolean

false

Description

Whether the select popup is initially open.

To render a controlled select popup, use the open prop instead.

Type
boolean | undefined
Default

false

open

boolean

Name
Description

Whether the select popup is currently open.

Type
boolean | undefined
onOpenChange

function

Description

Event handler called when the select popup is opened or closed.

Type
| ((
    open: boolean,
    eventDetails: Select.Root.ChangeEventDetails,
  ) => void)
| undefined
actionsRef

RefObject<Select.Root.Actions>

Description

A ref to imperative actions.

  • unmount: When specified, the select will not be unmounted when closed. Instead, the unmount function 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)

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.is comparison.

Type
| ((itemValue: Value, value: Value) => boolean)
| undefined
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)

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
items

Union

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
modal

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 | undefined
Default

true

multiple

boolean | undefined

false

Description

Whether multiple items can be selected.

Type
boolean | undefined
Default

false

onOpenChangeComplete

function

Description

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

Type
((open: boolean) => void) | undefined
disabled

boolean

false

Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default

false

readOnly

boolean

false

Description

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

Type
boolean | undefined
Default

false

required

boolean

false

Description

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

Type
boolean | undefined
Default

false

inputRef

Ref<HTMLInputElement>

Description

A ref to access the hidden input element.

Type
React.Ref<HTMLInputElement> | undefined
id

string

Name
Description

The id of the Select.

Type
string | undefined
children

ReactNode

Type
React.ReactNode | undefined

Trigger

A button that opens the select popup. Renders a <div> element.

nativeButton

boolean

false

Description

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.

Type
boolean | undefined
Default

false

disabled

boolean

false

Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default

false

children

ReactNode

Type
React.ReactNode
className

string | function

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

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)

Description

Accepts a function that returns a ReactNode to format the selected value.

Type
React.ReactNode | ((value: any) => ReactNode)
Example
className

string | function

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

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 popup. Renders a <span> element.

className

string | function

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

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)
data-popup-open

Present when the corresponding popup is open.

Backdrop

An overlay displayed beneath the menu popup. Renders a <div> element.

className

string | function

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

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

Description

A parent element to render the portal element into.

Type
| HTMLElement
| ShadowRoot
| React.RefObject<HTMLElement | ShadowRoot | null>
| null
| undefined
children

ReactNode

Type
React.ReactNode

Positioner

Positions the select popup. Renders a <div> element.

alignItemWithTrigger

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 | undefined
Default

true

collisionAvoidance

CollisionAvoidance

Description

Determines how to handle collisions when positioning the popup.

Type
| {
    side?: 'none' | 'flip'
    align?: 'shift' | 'none' | 'flip'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| {
    side?: 'shift' | 'none'
    align?: 'shift' | 'none'
    fallbackAxisSide?: 'none' | 'start' | 'end'
  }
| undefined
Example
align

Align

'center'

Name
Description

How to align the popup relative to the specified side.

Type
'center' | 'start' | 'end' | undefined
Default

'center'

alignOffset

number | OffsetFunction

0

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 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.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default

0

Example
side

Side

'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'

sideOffset

number | OffsetFunction

0

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 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.
Type
| number
| ((data: {
    side: Side
    align: Align
    anchor: { width: number; height: number }
    positioner: { width: number; height: number }
  }) => number)
| undefined
Default

0

Example
arrowPadding

number

5

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

anchor

Union

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
collisionBoundary

Boundary

'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'

collisionPadding

Padding

5

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

sticky

boolean

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'

Description

Determines which CSS position property to use.

Type
'fixed' | 'absolute' | undefined
Default

'absolute'

trackAnchor

boolean

true

Description

Whether the popup tracks any layout shift of its positioning anchor.

Type
boolean | undefined
Default

true

className

string | function

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

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.

A container for the select list. Renders a <div> element.

children

ReactNode

Type
React.ReactNode
className

string | function

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

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.

List

A container for the select items. Renders a <div> element.

className

string | function

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)
render

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.List.State,
  ) => ReactElement)

Arrow

Displays an element positioned against the select popup anchor. Renders a <div> element.

className

string | function

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

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 popup. Renders a <div> element.

label

string

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
value

any

null

Name
Description

A unique value that identifies this select item.

Type
any
Default

null

nativeButton

boolean

false

Description

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.

Type
boolean | undefined
Default

false

disabled

boolean

false

Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default

false

children

ReactNode

Type
React.ReactNode
className

string | function

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

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

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

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

Type
React.ReactNode
className

string | function

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

false

Description

Whether to keep the HTML element in the DOM when the item is not selected.

Type
boolean | undefined
Default

false

render

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

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

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

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

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 popup up when hovered. Does not render when using touch input. Renders a <div> element.

className

string | function

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

false

Description

Whether to keep the HTML element in the DOM while the select popup is not scrollable.

Type
boolean | undefined
Default

false

render

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 popup down when hovered. Does not render when using touch input. Renders a <div> element.

className

string | function

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

false

Description

Whether to keep the HTML element in the DOM while the select popup is not scrollable.

Type
boolean | undefined
Default

false

render

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

'horizontal'

Description

The orientation of the separator.

Type
'horizontal' | 'vertical' | undefined
Default

'horizontal'

className

string | function

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

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)

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 alignItemWithTrigger positioning 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-height on 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 side or align have no effect unless the prop is set to false or 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:

items prop

A function can also be passed as the children prop of Select.Value to render a formatted value:

Lookup map

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.