Base UI

A list of actions in a dropdown, enhanced with keyboard navigation.

import * as React from 'react';
import { Menu } from '@base-ui-components/react/menu';
import styles from './index.module.css';

export default function ExampleMenu() {
  return (
    <Menu.Root>
      <Menu.Trigger className={styles.Button}>
        Song <ChevronDownIcon className={styles.ButtonIcon} />
      </Menu.Trigger>
      <Menu.Portal>
        <Menu.Positioner className={styles.Positioner} sideOffset={8}>
          <Menu.Popup className={styles.Popup}>
            <Menu.Arrow className={styles.Arrow}>
              <ArrowSvg />
            </Menu.Arrow>
            <Menu.Item className={styles.Item}>Add to Library</Menu.Item>
            <Menu.Item className={styles.Item}>Add to Playlist</Menu.Item>
            <Menu.Separator className={styles.Separator} />
            <Menu.Item className={styles.Item}>Play Next</Menu.Item>
            <Menu.Item className={styles.Item}>Play Last</Menu.Item>
            <Menu.Separator className={styles.Separator} />
            <Menu.Item className={styles.Item}>Favorite</Menu.Item>
            <Menu.Item className={styles.Item}>Share</Menu.Item>
          </Menu.Popup>
        </Menu.Positioner>
      </Menu.Portal>
    </Menu.Root>
  );
}

function ArrowSvg(props: React.ComponentProps<'svg'>) {
  return (
    <svg width="20" height="10" viewBox="0 0 20 10" fill="none" {...props}>
      <path
        d="M9.66437 2.60207L4.80758 6.97318C4.07308 7.63423 3.11989 8 2.13172 8H0V10H20V8H18.5349C17.5468 8 16.5936 7.63423 15.8591 6.97318L11.0023 2.60207C10.622 2.2598 10.0447 2.25979 9.66437 2.60207Z"
        className={styles.ArrowFill}
      />
      <path
        d="M8.99542 1.85876C9.75604 1.17425 10.9106 1.17422 11.6713 1.85878L16.5281 6.22989C17.0789 6.72568 17.7938 7.00001 18.5349 7.00001L15.89 7L11.0023 2.60207C10.622 2.2598 10.0447 2.2598 9.66436 2.60207L4.77734 7L2.13171 7.00001C2.87284 7.00001 3.58774 6.72568 4.13861 6.22989L8.99542 1.85876Z"
        className={styles.ArrowOuterStroke}
      />
      <path
        d="M10.3333 3.34539L5.47654 7.71648C4.55842 8.54279 3.36693 9 2.13172 9H0V8H2.13172C3.11989 8 4.07308 7.63423 4.80758 6.97318L9.66437 2.60207C10.0447 2.25979 10.622 2.2598 11.0023 2.60207L15.8591 6.97318C16.5936 7.63423 17.5468 8 18.5349 8H20V9H18.5349C17.2998 9 16.1083 8.54278 15.1901 7.71648L10.3333 3.34539Z"
        className={styles.ArrowInnerStroke}
      />
    </svg>
  );
}

function ChevronDownIcon(props: React.ComponentProps<'svg'>) {
  return (
    <svg width="10" height="10" viewBox="0 0 10 10" fill="none" {...props}>
      <path d="M1 3.5L5 7.5L9 3.5" stroke="currentcolor" strokeWidth="1.5" />
    </svg>
  );
}

Anatomy

Import the component and assemble its parts:

Anatomy

import { Menu } from '@base-ui-components/react/menu';

<Menu.Root>
  <Menu.Trigger />
  <Menu.Portal>
    <Menu.Backdrop />
    <Menu.Positioner>
      <Menu.Popup>
        <Menu.Arrow />
        <Menu.Item />
        <Menu.Separator />
        <Menu.Group>
          <Menu.GroupLabel />
        </Menu.Group>
        <Menu.RadioGroup>
          <Menu.RadioItem />
        </Menu.RadioGroup>
        <Menu.CheckboxItem />
        <Menu.SubmenuRoot>
          <Menu.SubmenuTrigger />
        </Menu.SubmenuRoot>
      </Menu.Popup>
    </Menu.Positioner>
  </Menu.Portal>
</Menu.Root>

API reference

Root

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

defaultOpen

boolean

false

Name: defaultOpen
Description: Whether the menu is initially open.

To render a controlled menu, use the open prop instead.
Type: boolean | undefined
Default: false

open

boolean

—

Name: open
Description: Whether the menu is currently open.
Type: boolean | undefined

onOpenChange

function

—

Name: onOpenChange
Description: Event handler called when the menu is opened or closed.
Type: | (( open: boolean, eventDetails: Menu.Root.ChangeEventDetails, ) => void) | undefined

actionsRef

RefObject<Menu.Root.Actions>

—

Name: actionsRef
Description: A ref to imperative actions.

unmount: When specified, the menu will not be unmounted when closed. Instead, the unmount function must be called to unmount the menu manually. Useful when the menu's animation is controlled by an external library.
Type: React.RefObject<Menu.Root.Actions> | undefined

closeParentOnEsc

boolean

true

Name: closeParentOnEsc
Description: When in a submenu, determines whether pressing the Escape key closes the entire menu, or only the current child menu.
Type: boolean | undefined
Default: true

Name: modal
Description: Determines if the menu enters a modal state when open.

true: user interaction is limited to the menu: 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

onOpenChangeComplete

function

—

Name: onOpenChangeComplete
Description: Event handler called after any animations complete when the menu is closed.
Type: ((open: boolean) => void) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

openOnHover

boolean

—

Name: openOnHover
Description: Whether the menu should also open when the trigger is hovered.
Type: boolean | undefined

delay

number

100

Name: delay
Description: How long to wait before the menu may be opened on hover. Specified in milliseconds.

Requires the openOnHover prop.
Type: number | undefined
Default: 100

closeDelay

number

0

Name: closeDelay
Description: How long to wait before closing the menu that was opened on hover. Specified in milliseconds.

Requires the openOnHover prop.
Type: number | undefined
Default: 0

loop

boolean

true

Name: loop
Description: Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.
Type: boolean | undefined
Default: true

orientation

Menu.Root.Orientation

'vertical'

Name: orientation
Description: The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.
Type: 'horizontal' | 'vertical' | undefined
Default: 'vertical'

children^*

ReactNode

—

Name: children
Type: React.ReactNode

Trigger

A button that opens the menu. Renders a <button> element.

nativeButton

boolean

true

Name: nativeButton
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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Menu.Trigger.State) => CSSProperties | undefined) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

children

ReactNode

—

Name: children
Type: React.ReactNode

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Trigger.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Trigger.State, ) => ReactElement)

data-popup-open

Present when the corresponding menu is open.

data-pressed

Present when the trigger is pressed.

Attribute	Description	-
`data-popup-open`	Present when the corresponding menu is open.
`data-pressed`	Present when the trigger is pressed.

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.

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.Portal.State, ) => CSSProperties | undefined) | undefined

container

Union

—

Name: container
Description: A parent element to render the portal element into.
Type: | HTMLElement | ShadowRoot | React.RefObject<HTMLElement | ShadowRoot | null> | null | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Portal.State) => string | undefined)

keepMounted

boolean

false

Name: keepMounted
Description: Whether to keep the portal mounted in the DOM while the popup is hidden.
Type: boolean | undefined
Default: false

render

ReactElement | function

—

Name: render
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: Menu.Portal.State, ) => ReactElement)

Backdrop

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.Backdrop.State, ) => CSSProperties | undefined) | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Backdrop.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Backdrop.State, ) => ReactElement)

data-open

Present when the menu is open.

data-closed

Present when the menu is closed.

data-starting-style

Present when the menu is animating in.

data-ending-style

Present when the menu is animating out.

Attribute	Description	-
`data-open`	Present when the menu is open.
`data-closed`	Present when the menu is closed.
`data-starting-style`	Present when the menu is animating in.
`data-ending-style`	Present when the menu is animating out.

Positioner

Positions the menu popup against the trigger. Renders a <div> element.

collisionAvoidance

CollisionAvoidance

—

Name: collisionAvoidance
Description: Determines how to handle collisions when positioning the popup.
Type: | { side?: 'none' | 'flip' align?: 'none' | 'flip' | 'shift' fallbackAxisSide?: 'none' | 'end' | 'start' } | { side?: 'none' | 'shift' align?: 'none' | 'shift' fallbackAxisSide?: 'none' | 'end' | 'start' } | undefined
Example: <Positioner collisionAvoidance={{ side: 'shift', align: 'shift', fallbackAxisSide: 'none', }} />

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.Positioner.State, ) => CSSProperties | undefined) | undefined

align

Align

'center'

Name: align
Description: How to align the popup relative to the specified side.
Type: 'center' | 'end' | 'start' | undefined
Default: 'center'

alignOffset

number | OffsetFunction

0

Name: alignOffset
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: <Positioner alignOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.width : anchor.height; }} />

side

Side

'bottom'

Name: side
Description: Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
Type: | 'left' | 'right' | 'bottom' | 'top' | 'inline-end' | 'inline-start' | undefined
Default: 'bottom'

sideOffset

number | OffsetFunction

0

Name: sideOffset
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: <Positioner sideOffset={({ side, align, anchor, positioner }) => { return side === 'top' || side === 'bottom' ? anchor.height : anchor.width; }} />

arrowPadding

number

5

Name: arrowPadding
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: anchor
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'

Name: collisionBoundary
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

Name: collisionPadding
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: sticky
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'

Name: positionMethod
Description: Determines which CSS position property to use.
Type: 'fixed' | 'absolute' | undefined
Default: 'absolute'

trackAnchor

boolean

true

Name: trackAnchor
Description: Whether the popup tracks any layout shift of its positioning anchor.
Type: boolean | undefined
Default: true

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Positioner.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Positioner.State, ) => ReactElement)

data-open

Present when the menu popup is open.

data-closed

Present when the menu 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.

Attribute	Description	-
`data-open`	Present when the menu popup is open.
`data-closed`	Present when the menu 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.

CSS Variable	Description	-
`--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 menu items. Renders a <div> element.

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Menu.Popup.State) => CSSProperties | undefined) | undefined

finalFocus

Union

—

Name: finalFocus
Description: Determines the element to focus when the menu 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

id

string

—

Name: id
Type: string | undefined

children

ReactNode

—

Name: children
Type: React.ReactNode

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Popup.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Popup.State, ) => ReactElement)

data-open

Present when the menu is open.

data-closed

Present when the menu is closed.

data-align

Indicates how the popup is aligned relative to specified side.

data-instant

Present if animations should be instant.

data-side

Indicates which side the popup is positioned relative to the trigger.

data-starting-style

Present when the menu is animating in.

data-ending-style

Present when the menu is animating out.

Attribute	Description	-
`data-open`	Present when the menu is open.
`data-closed`	Present when the menu is closed.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-instant`	Present if animations should be instant.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-starting-style`	Present when the menu is animating in.
`data-ending-style`	Present when the menu is animating out.

Arrow

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Menu.Arrow.State) => CSSProperties | undefined) | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Arrow.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Arrow.State, ) => ReactElement)

data-open

Present when the menu popup is open.

data-closed

Present when the menu popup is closed.

data-uncentered

Present when the menu 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.

Attribute	Description	-
`data-open`	Present when the menu popup is open.
`data-closed`	Present when the menu popup is closed.
`data-uncentered`	Present when the menu 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 interactive item in the menu. Renders a <div> element.

label

string

—

Name: label
Description: Overrides the text label to use when the item is matched during keyboard text navigation.
Type: string | undefined

onClick

function

—

Name: onClick
Description: The click handler for the menu item.
Type: React.MouseEventHandler<HTMLElement> | undefined

closeOnClick

boolean

true

Name: closeOnClick
Description: Whether to close the menu when the item is clicked.
Type: boolean | undefined
Default: true

nativeButton

boolean

false

Name: nativeButton
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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Menu.Item.State) => CSSProperties | undefined) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

id

string

—

Name: id
Type: string | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Item.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Item.State, ) => ReactElement)

data-highlighted

Present when the menu item is highlighted.

data-disabled

Present when the menu item is disabled.

Attribute	Description	-
`data-highlighted`	Present when the menu item is highlighted.
`data-disabled`	Present when the menu item is disabled.

SubmenuRoot

Groups all parts of a submenu. Doesn’t render its own HTML element.

defaultOpen

boolean

false

Name: defaultOpen
Description: Whether the menu is initially open.

To render a controlled menu, use the open prop instead.
Type: boolean | undefined
Default: false

open

boolean

—

Name: open
Description: Whether the menu is currently open.
Type: boolean | undefined

onOpenChange

function

—

Name: onOpenChange
Description: Event handler called when the menu is opened or closed.
Type: | (( open: boolean, eventDetails: Menu.SubmenuRoot.ChangeEventDetails, ) => void) | undefined

actionsRef

RefObject<Menu.Root.Actions>

—

Name: actionsRef
Description: A ref to imperative actions.

unmount: When specified, the menu will not be unmounted when closed. Instead, the unmount function must be called to unmount the menu manually. Useful when the menu's animation is controlled by an external library.
Type: React.RefObject<Menu.Root.Actions> | undefined

closeParentOnEsc

boolean

true

Name: closeParentOnEsc
Description: When in a submenu, determines whether pressing the Escape key closes the entire menu, or only the current child menu.
Type: boolean | undefined
Default: true

onOpenChangeComplete

function

—

Name: onOpenChangeComplete
Description: Event handler called after any animations complete when the menu is closed.
Type: ((open: boolean) => void) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

openOnHover

boolean

true

Name: openOnHover
Description: Whether the submenu should open when the trigger is hovered.
Type: boolean | undefined
Default: true

delay

number

100

Name: delay
Description: How long to wait before the menu may be opened on hover. Specified in milliseconds.

Requires the openOnHover prop.
Type: number | undefined
Default: 100

closeDelay

number

0

Name: closeDelay
Description: How long to wait before closing the menu that was opened on hover. Specified in milliseconds.

Requires the openOnHover prop.
Type: number | undefined
Default: 0

loop

boolean

true

Name: loop
Description: Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.
Type: boolean | undefined
Default: true

orientation

Menu.Root.Orientation

'vertical'

Name: orientation
Description: The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.
Type: 'horizontal' | 'vertical' | undefined
Default: 'vertical'

children^*

ReactNode

—

Name: children
Type: React.ReactNode

SubmenuTrigger

A menu item that opens a submenu. Renders a <div> element.

label

string

—

Name: label
Description: Overrides the text label to use when the item is matched during keyboard text navigation.
Type: string | undefined

onClick

function

—

Name: onClick
Type: React.MouseEventHandler<HTMLElement> | undefined

nativeButton

boolean

false

Name: nativeButton
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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.SubmenuTrigger.State, ) => CSSProperties | undefined) | undefined

id

string

—

Name: id
Type: string | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.SubmenuTrigger.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.SubmenuTrigger.State, ) => ReactElement)

data-popup-open

Present when the corresponding submenu is open.

Attribute	Description	-
`data-popup-open`	Present when the corresponding submenu is open.

Group

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Menu.Group.State) => CSSProperties | undefined) | undefined

children

ReactNode

—

Name: children
Description: The content of the component.
Type: React.ReactNode

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.Group.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.Group.State, ) => ReactElement)

GroupLabel

An accessible label that is automatically associated with its parent group. Renders a <div> element.

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.GroupLabel.State, ) => CSSProperties | undefined) | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.GroupLabel.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.GroupLabel.State, ) => ReactElement)

RadioGroup

Groups related radio items. Renders a <div> element.

defaultValue

any

—

Name: defaultValue
Description: The uncontrolled value of the radio item that should be initially selected.

To render a controlled radio group, use the value prop instead.
Type: any

value

any

—

Name: value
Description: The controlled value of the radio item that should be currently selected.

To render an uncontrolled radio group, use the defaultValue prop instead.
Type: any

onValueChange

function

—

Name: onValueChange
Description: Function called when the selected value changes.
Type: | (( value: any, eventDetails: Menu.RadioGroup.ChangeEventDetails, ) => void) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.RadioGroup.State, ) => CSSProperties | undefined) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

children

ReactNode

—

Name: children
Description: The content of the component.
Type: React.ReactNode

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.RadioGroup.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.RadioGroup.State, ) => ReactElement)

RadioItem

A menu item that works like a radio button in a given group. Renders a <div> element.

label

string

—

Name: label
Description: Overrides the text label to use when the item is matched during keyboard text navigation.
Type: string | undefined

value^*

any

—

Name: value
Description: Value of the radio item. This is the value that will be set in the Menu.RadioGroup when the item is selected.
Type: any

onClick

function

—

Name: onClick
Description: The click handler for the menu item.
Type: React.MouseEventHandler<HTMLElement> | undefined

closeOnClick

boolean

false

Name: closeOnClick
Description: Whether to close the menu when the item is clicked.
Type: boolean | undefined
Default: false

nativeButton

boolean

false

Name: nativeButton
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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.RadioItem.State, ) => CSSProperties | undefined) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

id

string

—

Name: id
Type: string | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.RadioItem.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.RadioItem.State, ) => ReactElement)

data-checked

Present when the menu radio item is selected.

data-unchecked

Present when the menu radio item is not selected.

data-highlighted

Present when the menu radio item is highlighted.

data-disabled

Present when the menu radio item is disabled.

Attribute	Description	-
`data-checked`	Present when the menu radio item is selected.
`data-unchecked`	Present when the menu radio item is not selected.
`data-highlighted`	Present when the menu radio item is highlighted.
`data-disabled`	Present when the menu radio item is disabled.

RadioItemIndicator

Indicates whether the radio item is selected. Renders a <div> element.

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.RadioItemIndicator.State, ) => CSSProperties | undefined) | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | (( state: Menu.RadioItemIndicator.State, ) => string | undefined)

keepMounted

boolean

false

Name: keepMounted
Description: Whether to keep the HTML element in the DOM when the radio item is inactive.
Type: boolean | undefined
Default: false

render

ReactElement | function

—

Name: render
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: Menu.RadioItemIndicator.State, ) => ReactElement)

data-checked

Present when the menu radio item is selected.

data-unchecked

Present when the menu radio item is not selected.

data-disabled

Present when the menu radio item is disabled.

data-starting-style

Present when the radio indicator is animating in.

data-ending-style

Present when the radio indicator is animating out.

Attribute	Description	-
`data-checked`	Present when the menu radio item is selected.
`data-unchecked`	Present when the menu radio item is not selected.
`data-disabled`	Present when the menu radio item is disabled.
`data-starting-style`	Present when the radio indicator is animating in.
`data-ending-style`	Present when the radio indicator is animating out.

CheckboxItem

A menu item that toggles a setting on or off. Renders a <div> element.

label

string

—

Name: label
Description: Overrides the text label to use when the item is matched during keyboard text navigation.
Type: string | undefined

defaultChecked

boolean

false

Name: defaultChecked
Description: Whether the checkbox item is initially ticked.

To render a controlled checkbox item, use the checked prop instead.
Type: boolean | undefined
Default: false

checked

boolean

—

Name: checked
Description: Whether the checkbox item is currently ticked.

To render an uncontrolled checkbox item, use the defaultChecked prop instead.
Type: boolean | undefined

onCheckedChange

function

—

Name: onCheckedChange
Description: Event handler called when the checkbox item is ticked or unticked.
Type: | (( checked: boolean, eventDetails: Menu.CheckboxItem.ChangeEventDetails, ) => void) | undefined

onClick

function

—

Name: onClick
Description: The click handler for the menu item.
Type: React.MouseEventHandler<HTMLElement> | undefined

closeOnClick

boolean

false

Name: closeOnClick
Description: Whether to close the menu when the item is clicked.
Type: boolean | undefined
Default: false

nativeButton

boolean

false

Name: nativeButton
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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.CheckboxItem.State, ) => CSSProperties | undefined) | undefined

disabled

boolean

false

Name: disabled
Description: Whether the component should ignore user interaction.
Type: boolean | undefined
Default: false

id

string

—

Name: id
Type: string | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: Menu.CheckboxItem.State) => string | undefined)

render

ReactElement | function

—

Name: render
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: Menu.CheckboxItem.State, ) => ReactElement)

data-checked

Present when the menu checkbox item is checked.

data-unchecked

Present when the menu checkbox item is not checked.

data-highlighted

Present when the menu checkbox item is highlighted.

data-disabled

Present when the menu checkbox item is disabled.

Attribute	Description	-
`data-checked`	Present when the menu checkbox item is checked.
`data-unchecked`	Present when the menu checkbox item is not checked.
`data-highlighted`	Present when the menu checkbox item is highlighted.
`data-disabled`	Present when the menu checkbox item is disabled.

CheckboxItemIndicator

Indicates whether the checkbox item is ticked. Renders a <div> element.

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: Menu.CheckboxItemIndicator.State, ) => CSSProperties | undefined) | undefined

className

string | function

—

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | (( state: Menu.CheckboxItemIndicator.State, ) => string | undefined)

keepMounted

boolean

false

Name: keepMounted
Description: Whether to keep the HTML element in the DOM when the checkbox item is not checked.
Type: boolean | undefined
Default: false

render

ReactElement | function

—

Name: render
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: Menu.CheckboxItemIndicator.State, ) => ReactElement)

data-checked

Present when the menu checkbox item is checked.

data-unchecked

Present when the menu checkbox item is not checked.

data-disabled

Present when the menu checkbox item is disabled.

data-starting-style

Present when the indicator is animating in.

data-ending-style

Present when the indicator is animating out.

Attribute	Description	-
`data-checked`	Present when the menu checkbox item is checked.
`data-unchecked`	Present when the menu checkbox item is not checked.
`data-disabled`	Present when the menu checkbox item is disabled.
`data-starting-style`	Present when the indicator is animating in.
`data-ending-style`	Present when the indicator is animating out.

Separator

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | ((state: Separator.State) => CSSProperties | undefined) | undefined

orientation

Orientation

'horizontal'

Name: orientation
Description: The orientation of the separator.
Type: 'horizontal' | 'vertical' | undefined
Default: 'horizontal'

className

string | function

—

Name: className
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)

render

ReactElement | function

—

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

Examples

Open on hover

To create a menu that opens on hover, add the openOnHover prop to the Root part. You can additionally configure how quickly the menu opens on hover using the delay prop.

Checkbox items

Use the <Menu.CheckboxItem> part to create a menu item that can toggle a setting on or off.

Radio items

Use the <Menu.RadioGroup> and <Menu.RadioItem> parts to create menu items that work like radio buttons.

Close on click

Use the closeOnClick prop to change whether the menu closes when an item is clicked.

Control whether the menu closes on click

// Close the menu when a checkbox item is clicked
<Menu.CheckboxItem closeOnClick />

// Keep the menu open when an item is clicked
<Menu.Item closeOnClick={false} />

Group labels

Use the <Menu.GroupLabel> part to add a label to a <Menu.Group>

To create a submenu, nest another menu inside the parent menu with <Menu.SubmenuRoot>. Use the <Menu.SubmenuTrigger> part for the menu item that opens the nested menu.

Adding a submenu

<Menu.Root>
  <Menu.Trigger />
  <Menu.Portal>
    <Menu.Positioner>
      <Menu.Popup>
        <Menu.Arrow />
        <Menu.Item />

        {/* Submenu */}
        <Menu.SubmenuRoot>
          <Menu.SubmenuTrigger />
          <Menu.Portal>
            <Menu.Positioner>
              <Menu.Popup>
                {/* Submenu items  */}
              </Menu.Popup>
            </Menu.Positioner>
          </Menu.Portal>
        </Menu.SubmenuRoot>
      </Menu.Popup>
    </Menu.Positioner>
  </Menu.Portal>
</Menu.Root>

Navigate to another page

Use the render prop to compose a menu item with an anchor element.

A menu item that opens a link

<Menu.Item render={<a href="/projects">Go to Projects</a>} />

Open a dialog

In order to open a dialog using a menu, control the dialog state and open it imperatively using the onClick handler on the menu item.

Connecting a dialog to a menu

import * as React from 'react';
import { Dialog } from '@base-ui-components/react/dialog';
import { Menu } from '@base-ui-components/react/menu';

function ExampleMenu() {
  const [dialogOpen, setDialogOpen] = React.useState(false);

  return (
    <React.Fragment>
      <Menu.Root>
        <Menu.Trigger>Open menu</Menu.Trigger>
        <Menu.Portal>
          <Menu.Positioner>
            <Menu.Popup>
              {/* Open the dialog when the menu item is clicked */}
              <Menu.Item onClick={() => setDialogOpen(true)}>Open dialog</Menu.Item>
            </Menu.Popup>
          </Menu.Positioner>
        </Menu.Portal>
      </Menu.Root>

      {/* Control the dialog state */}
      <Dialog.Root open={dialogOpen} onOpenChange={setDialogOpen}>
        <Dialog.Portal>
          <Dialog.Backdrop />
          <Dialog.Popup>
            {/* Rest of the dialog */}
          </Dialog.Popup>
        </Dialog.Portal>
      </Dialog.Root>
    </React.Fragment>
  );
}