Skip to contents

Select

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

View as Markdown
Apple

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.
  • Form controls must have an accessible name: It can be created using the Field component. See Labeling a select and the forms guide.

Anatomy

Import the component and assemble its parts:

Anatomy

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.

Examples

Typed wrapper component

The following example shows a typed wrapper around the Select component with correct type inference and type safety:

Specifying generic type parameters

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.

Labeling a select

Use the Field component to provide a visible label for the select trigger:

Using Field to label a select

Replace the rendered <label> element with a <div> element and add nativeLabel={false} so it does not inherit native label behaviors. This ensures clicking on the label will focus the select trigger without opening the associated popup to match native <select> behavior, and prevents CSS :hover from activating on the trigger when hovering over the label.

Placeholder values

To show a placeholder value, use the placeholder prop on <Select.Value>:

Placeholder item

With placeholders, users cannot clear selected values using the select itself. If the select value should be clearable from the popup (instead of an external “reset” button), use a null item rendered in the list itself:

Clearable item

Multiple selection

Add the multiple prop to the <Select.Root> component to allow multiple selections.

Languages

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.

Shipping method

Grouped

Organize related options with <Select.Group> and <Select.GroupLabel> to add section headings inside the popup.

Groups are represented by an array of objects with an items property, which itself is an array of individual items for each group. An extra property, such as value, can be provided for the heading text when rendering the group label.

Example
Produce

API reference

Root

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

namestring
Name
Description

Identifies the field when a form is submitted.

Type
string | undefined
defaultValueUnion
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
valueUnion
Name
Description

The value of the select. Use when controlled.

Type
Value[] | Value | null | undefined
onValueChangefunction
Description

Event handler called when the value of the select changes.

Type
| ((
    value: Value[] | Value | any | null,
    eventDetails: Select.Root.ChangeEventDetails,
  ) => void)
| undefined
defaultOpenbooleanfalse
Description

Whether the select popup is initially open.

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

Type
boolean | undefined
Default
false
openboolean
Name
Description

Whether the select popup is currently open.

Type
boolean | undefined
onOpenChangefunction
Description

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

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

Whether moving the pointer over items should highlight them. Disabling this prop allows CSS :hover to be differentiated from the :focus (data-highlighted) state.

Type
boolean | undefined
Default
true
actionsRefRefObject<Select.Root.Actions | null>
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 | null>
| undefined
autoCompletestring
Description

Provides a hint to the browser for autofill.

Type
string | 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
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>
| Group[]
| { label: ReactNode; value: any }[]
| undefined
Example
modalbooleantrue
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 pointer interactions on outside elements are disabled.
  • false: user interaction with the rest of the document is allowed.
Type
boolean | undefined
Default
true
multipleboolean | undefinedfalse
Description

Whether multiple items can be selected.

Type
boolean | undefined
Default
false
onOpenChangeCompletefunction
Description

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

Type
((open: boolean) => void) | undefined
disabledbooleanfalse
Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default
false
readOnlybooleanfalse
Description

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

Type
boolean | undefined
Default
false
requiredbooleanfalse
Description

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

Type
boolean | undefined
Default
false
inputRefRef<HTMLInputElement>
Description

A ref to access the hidden input element.

Type
React.Ref<HTMLInputElement> | undefined
idstring
Name
Description

The id of the Select.

Type
string | undefined
childrenReactNode
Type
React.ReactNode

Trigger

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

nativeButtonbooleantrue
Description

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 (e.g. <div>).

Type
boolean | undefined
Default
true
disabledboolean
Description

Whether the component should ignore user interaction.

Type
boolean | undefined
childrenReactNode
Type
React.ReactNode
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.Trigger.State,
  ) => CSSProperties | undefined)
| undefined
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 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).
data-placeholder
Present when the select doesn't have a value.
AttributeDescription
data-popup-openPresent when the corresponding select is open.
data-pressedPresent when the trigger is pressed.
data-disabledPresent when the select is disabled.
data-readonlyPresent when the select is readonly.
data-requiredPresent when the select is required.
data-validPresent when the select is in valid state (when wrapped in Field.Root).
data-invalidPresent when the select is in invalid state (when wrapped in Field.Root).
data-dirtyPresent when the select's value has changed (when wrapped in Field.Root).
data-touchedPresent when the select has been touched (when wrapped in Field.Root).
data-filledPresent when the select has a value (when wrapped in Field.Root).
data-focusedPresent when the select trigger is focused (when wrapped in Field.Root).
data-placeholderPresent when the select doesn't have a value.

Value

A text label of the currently selected item. Renders a <span> element.

placeholderReactNode
Description

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.

Type
React.ReactNode
childrenReactNode | ((value: any) => ReactNode)
Description

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

Type
React.ReactNode | ((value: any) => ReactNode)
Example
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Value.State) => CSSProperties | undefined)
| undefined
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 ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Select.Value.State,
  ) => ReactElement)
data-placeholder
Present when the select doesn't have a value.
AttributeDescription
data-placeholderPresent when the select doesn't have a value.

Icon

An icon that indicates that the trigger button opens a select popup. Renders a <span> element.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Icon.State) => CSSProperties | undefined)
| undefined
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 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.
AttributeDescription
data-popup-openPresent when the corresponding popup is open.

Backdrop

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

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.Backdrop.State,
  ) => CSSProperties | undefined)
| undefined
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 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.
AttributeDescription
data-openPresent when the select is open.
data-closedPresent when the select is closed.
data-starting-stylePresent when the select is animating in.
data-ending-stylePresent 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
Description

A parent element to render the portal element into.

Type
| HTMLElement
| ShadowRoot
| React.RefObject<HTMLElement | ShadowRoot | null>
| null
| undefined
classNamestring | 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.Portal.State) => string | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.Portal.State,
  ) => CSSProperties | undefined)
| undefined
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 ReactElement or 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.

alignItemWithTriggerbooleantrue
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
disableAnchorTrackingbooleanfalse
Description

Whether to disable the popup from tracking any layout shift of its positioning anchor.

Type
boolean | undefined
Default
false
alignAlign'center'
Name
Description

How to align the popup relative to the specified side.

Type
'start' | 'center' | 'end' | undefined
Default
'center'
alignOffsetnumber | OffsetFunction0
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
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 | OffsetFunction0
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
arrowPaddingnumber5
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
Name
Description

An element to position the popup against. By default, the popup will be positioned against the trigger.

Type
| Element
| VirtualElement
| React.RefObject<Element | null>
| (() => Element | VirtualElement | null)
| null
| undefined
collisionAvoidanceCollisionAvoidance
Description

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

Type
| {
    side?: 'flip' | 'none'
    align?: 'flip' | 'shift' | 'none'
    fallbackAxisSide?: 'start' | 'end' | 'none'
  }
| {
    side?: 'shift' | 'none'
    align?: 'shift' | 'none'
    fallbackAxisSide?: 'start' | 'end' | 'none'
  }
| undefined
Example
collisionBoundaryBoundary'clipping-ancestors'
Description

An element or a rectangle that delimits the area that the popup is confined to.

Type
| 'clipping-ancestors'
| Element
| Element[]
| Rect
| undefined
Default
'clipping-ancestors'
collisionPaddingPadding5
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
stickybooleanfalse
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'absolute' | 'fixed''absolute'
Description

Determines which CSS position property to use.

Type
'absolute' | 'fixed' | undefined
Default
'absolute'
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.Positioner.State,
  ) => CSSProperties | undefined)
| undefined
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 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.
AttributeDescription
data-openPresent when the select popup is open.
data-closedPresent when the select popup is closed.
data-anchor-hiddenPresent when the anchor is hidden.
data-alignIndicates how the popup is aligned relative to specified side.
data-sideIndicates 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.
CSS VariableDescription
--anchor-heightThe anchor's height.
--anchor-widthThe anchor's width.
--available-heightThe available height between the trigger and the edge of the viewport.
--available-widthThe available width between the trigger and the edge of the viewport.
--transform-originThe coordinates that this element is anchored to. Used for animations and transitions.

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

finalFocusUnion
Description

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.
Type
| boolean
| React.RefObject<HTMLElement | null>
| ((
    closeType: InteractionType,
  ) => boolean | void | HTMLElement | null)
| undefined
childrenReactNode
Type
React.ReactNode
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Popup.State) => CSSProperties | undefined)
| undefined
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 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.
AttributeDescription
data-openPresent when the select is open.
data-closedPresent when the select is closed.
data-alignIndicates how the popup is aligned relative to specified side.
data-sideIndicates which side the popup is positioned relative to the trigger.
data-starting-stylePresent when the select is animating in.
data-ending-stylePresent when the select is animating out.

List

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

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.List.State) => CSSProperties | undefined)
| undefined
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 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.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Arrow.State) => CSSProperties | undefined)
| undefined
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 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-align
Indicates how the popup is aligned relative to specified side.
data-side
Indicates which side the popup is positioned relative to the trigger.
AttributeDescription
data-openPresent when the select popup is open.
data-closedPresent when the select popup is closed.
data-uncenteredPresent when the select arrow is uncentered.
data-alignIndicates how the popup is aligned relative to specified side.
data-sideIndicates which side the popup is positioned relative to the trigger.

Item

An individual option in the select popup. Renders a <div> element.

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
valueanynull
Name
Description

A unique value that identifies this select item.

Type
any
Default
null
nativeButtonbooleanfalse
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
disabledbooleanfalse
Description

Whether the component should ignore user interaction.

Type
boolean | undefined
Default
false
childrenReactNode
Type
React.ReactNode
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Item.State) => CSSProperties | undefined)
| undefined
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 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.
AttributeDescription
data-selectedPresent when the select item is selected.
data-highlightedPresent when the select item is highlighted.
data-disabledPresent when the select item is disabled.

ItemText

A text label of the select item. Renders a <div> element.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.ItemText.State,
  ) => CSSProperties | undefined)
| undefined
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 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.

childrenReactNode
Type
React.ReactNode
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.ItemIndicator.State,
  ) => CSSProperties | undefined)
| undefined
keepMountedboolean
Description

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

Type
boolean | undefined
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 ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Select.ItemIndicator.State,
  ) => ReactElement)
data-starting-style
Present when the indicator is animating in.
data-ending-style
Present when the indicator is animating out.
AttributeDescription
data-starting-stylePresent when the indicator is animating in.
data-ending-stylePresent when the indicator is animating out.

Group

Groups related select items with the corresponding label. Renders a <div> element.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Select.Group.State) => CSSProperties | undefined)
| undefined
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 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.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.GroupLabel.State,
  ) => CSSProperties | undefined)
| undefined
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 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.

classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.ScrollUpArrow.State,
  ) => CSSProperties | undefined)
| undefined
keepMountedbooleanfalse
Description

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

Type
boolean | undefined
Default
false
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 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.
AttributeDescription
data-directionIndicates the direction of the scroll arrow.
data-sideIndicates which side the popup is positioned relative to the trigger.
data-visiblePresent when the scroll arrow is visible.
data-starting-stylePresent when the scroll arrow is animating in.
data-ending-stylePresent 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
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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((
    state: Select.ScrollDownArrow.State,
  ) => CSSProperties | undefined)
| undefined
keepMountedbooleanfalse
Description

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

Type
boolean | undefined
Default
false
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 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.
AttributeDescription
data-directionIndicates the direction of the scroll arrow.
data-sideIndicates which side the popup is positioned relative to the trigger.
data-visiblePresent when the scroll arrow is visible.
data-starting-stylePresent when the scroll arrow is animating in.
data-ending-stylePresent when the scroll arrow is animating out.

Separator

A separator element accessible to screen readers. Renders a <div> element.

orientationOrientation'horizontal'
Description

The orientation of the separator.

Type
'horizontal' | 'vertical' | undefined
Default
'horizontal'
classNamestring | 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 | undefined)
styleReact.CSSProperties | function
Name
Type
| React.CSSProperties
| ((state: Separator.State) => CSSProperties | undefined)
| undefined
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 ReactElement or a function that returns the element to render.

Type
| ReactElement
| ((
    props: HTMLProps,
    state: Separator.State,
  ) => ReactElement)