Base UI

A menu that appears at the pointer on right click or long press.

Right click here

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

export default function ExampleMenu() {
  return (
    <ContextMenu.Root>
      <ContextMenu.Trigger className={styles.Trigger}>Right click here</ContextMenu.Trigger>
      <ContextMenu.Portal>
        <ContextMenu.Positioner className={styles.Positioner}>
          <ContextMenu.Popup className={styles.Popup}>
            <ContextMenu.Item className={styles.Item}>Add to Library</ContextMenu.Item>
            <ContextMenu.Item className={styles.Item}>Add to Playlist</ContextMenu.Item>
            <ContextMenu.Separator className={styles.Separator} />
            <ContextMenu.Item className={styles.Item}>Play Next</ContextMenu.Item>
            <ContextMenu.Item className={styles.Item}>Play Last</ContextMenu.Item>
            <ContextMenu.Separator className={styles.Separator} />
            <ContextMenu.Item className={styles.Item}>Favorite</ContextMenu.Item>
            <ContextMenu.Item className={styles.Item}>Share</ContextMenu.Item>
          </ContextMenu.Popup>
        </ContextMenu.Positioner>
      </ContextMenu.Portal>
    </ContextMenu.Root>
  );
}

Anatomy

Import the components and place them together:

Anatomy

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

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

API reference

Root

A component that creates a context menu activated by right clicking or long pressing. Doesn’t render its own HTML element.

defaultOpen

boolean

(default:

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: ContextMenu.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

(default:

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

(default:

false

)

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

loop

boolean

(default:

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

(default:

'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

An area that opens the menu on right click or long press. Renders a <div> element.

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: ContextMenu.Trigger.State) => string)

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

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

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

children

ReactNode

Name: children
Type: React.ReactNode

keepMounted

boolean

(default:

false

)

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

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?: 'shift' | 'none' | 'flip' fallbackAxisSide?: 'none' | 'start' | 'end' } | { side?: 'shift' | 'none' align?: 'shift' | 'none' fallbackAxisSide?: 'none' | 'start' | 'end' } | undefined
Example: <Positioner collisionAvoidance={{ side: 'shift', align: 'shift', fallbackAxisSide: 'none', }} />

align

Align

(default:

'center'

)

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

alignOffset

number | OffsetFunction

(default:

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

(default:

'bottom'

)

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

(default:

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

(default:

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

(default:

'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

(default:

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

(default:

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'

(default:

'absolute'

)

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

trackAnchor

boolean

(default:

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)

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.

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)

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.

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)

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

(default:

true

)

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

nativeButton

boolean

(default:

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

disabled

boolean

(default:

false

)

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

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.Item.State) => string)

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

(default:

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

(default:

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

(default:

false

)

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

openOnHover

boolean

(default:

true

)

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

delay

number

(default:

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

(default:

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

(default:

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

(default:

'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

(default:

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

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.SubmenuTrigger.State) => string)

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.

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)

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.

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)

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

disabled

boolean

(default:

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)

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

(default:

false

)

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

nativeButton

boolean

(default:

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

disabled

boolean

(default:

false

)

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

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.RadioItem.State) => string)

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.

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)

keepMounted

boolean

(default:

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

(default:

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

(default:

false

)

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

nativeButton

boolean

(default:

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

disabled

boolean

(default:

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)

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.

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)

keepMounted

boolean

(default:

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.

orientation

Orientation

(default:

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

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

Menu displays additional demos, many of which apply to the context menu as well.

To create a submenu, create a <ContextMenu.SubmenuRoot> inside the parent context menu. Use the <ContextMenu.SubmenuTrigger> part for the menu item that opens the nested menu.

Right click here

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

export default function ExampleContextMenu() {
  return (
    <ContextMenu.Root>
      <ContextMenu.Trigger className={styles.Trigger}>Right click here</ContextMenu.Trigger>
      <ContextMenu.Portal>
        <ContextMenu.Positioner className={styles.Positioner}>
          <ContextMenu.Popup className={styles.Popup}>
            <ContextMenu.Item className={styles.Item}>Add to Library</ContextMenu.Item>

            <ContextMenu.SubmenuRoot>
              <ContextMenu.SubmenuTrigger className={styles.SubmenuTrigger}>
                Add to Playlist
                <ChevronRightIcon />
              </ContextMenu.SubmenuTrigger>
              <ContextMenu.Portal>
                <ContextMenu.Positioner
                  className={styles.Positioner}
                  alignOffset={-4}
                  sideOffset={-4}
                >
                  <ContextMenu.Popup className={styles.SubmenuPopup}>
                    <ContextMenu.Item className={styles.Item}>Get Up!</ContextMenu.Item>
                    <ContextMenu.Item className={styles.Item}>Inside Out</ContextMenu.Item>
                    <ContextMenu.Item className={styles.Item}>Night Beats</ContextMenu.Item>
                    <Menu.Separator className={styles.Separator} />
                    <ContextMenu.Item className={styles.Item}>New playlist…</ContextMenu.Item>
                  </ContextMenu.Popup>
                </ContextMenu.Positioner>
              </ContextMenu.Portal>
            </ContextMenu.SubmenuRoot>

            <ContextMenu.Separator className={styles.Separator} />
            <ContextMenu.Item className={styles.Item}>Play Next</ContextMenu.Item>
            <ContextMenu.Item className={styles.Item}>Play Last</ContextMenu.Item>
            <ContextMenu.Separator className={styles.Separator} />
            <ContextMenu.Item className={styles.Item}>Favorite</ContextMenu.Item>
            <ContextMenu.Item className={styles.Item}>Share</ContextMenu.Item>
          </ContextMenu.Popup>
        </ContextMenu.Positioner>
      </ContextMenu.Portal>
    </ContextMenu.Root>
  );
}

function ChevronRightIcon(props: React.ComponentProps<'svg'>) {
  return (
    <svg width="10" height="10" viewBox="0 0 10 10" fill="none" {...props}>
      <path d="M3.5 9L7.5 5L3.5 1" stroke="currentcolor" strokeWidth="1.5" />
    </svg>
  );
}

Context Menu

Anatomy

API reference

Root

Trigger

Portal

Positioner

Arrow

Item

SubmenuRoot

SubmenuTrigger

Group

GroupLabel

RadioGroup

RadioItem

RadioItemIndicator

CheckboxItem

CheckboxItemIndicator

Separator

Examples

Nested menu