Base UI

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

Right click here

import { ContextMenu } from '@base-ui/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/react/context-menu';

<ContextMenu.Root>
  <ContextMenu.Trigger />
  <ContextMenu.Portal>
    <ContextMenu.Backdrop />
    <ContextMenu.Positioner>
      <ContextMenu.Popup>
        <ContextMenu.Arrow />
        <ContextMenu.Item />
        <ContextMenu.LinkItem />
        <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>

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

index.tsx index.module.css theme.css

import * as React from 'react';
import { ContextMenu } from '@base-ui/react/context-menu';
import { Menu } from '@base-ui/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>
  );
}

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

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

highlightItemOnHover

boolean

true

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

actionsRef

React.RefObject<MenuRoot.Actions | null>

—

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.

close: When specified, the menu can be closed imperatively.
Type: React.RefObject<MenuRoot.Actions | null> | undefined

closeParentOnEsc

boolean

false

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

defaultTriggerId

string | null

—

Name: defaultTriggerId
Description: ID of the trigger that the popover is associated with. This is useful in conjunction with the defaultOpen prop to create an initially open popover.
Type: string | null | undefined

handle

MenuHandle<unknown>

—

Name: handle
Description: A handle to associate the menu with a trigger. If specified, allows external triggers to control the menu’s open state.
Type: MenuHandle<unknown> | undefined

loopFocus

boolean

true

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

onOpenChangeComplete

function

—

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

triggerId

string | null

—

Name: triggerId
Description: ID of the trigger that the popover is associated with. This is useful in conjunction with the open prop to create a controlled popover. There’s no need to specify this prop when the popover is uncontrolled (that is, when the open prop is not set).
Type: string | null | undefined

disabled

boolean

false

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

orientation

MenuRoot.Orientation

'vertical'

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

children

| React.ReactNode 
|  PayloadChildRenderFunction<unknown>

—

Name: children
Description: The content of the popover. This can be a regular React node or a render function that receives the payload of the active trigger.
Type: React.ReactNode | ((arg: { payload: unknown }) => ReactNode)<unknown> | undefined

Additional Types

ContextMenu.Root.Props

Re-Export of Root props as ContextMenuRootProps

ContextMenu.Root.State

type ContextMenuRootState = {};

ContextMenu.Root.Actions

type ContextMenuRootActions = { unmount: () => void; close: () => void };

ContextMenu.Root.ChangeEventReason

type ContextMenuRootChangeEventReason =
  | 'trigger-hover'
  | 'trigger-focus'
  | 'trigger-press'
  | 'outside-press'
  | 'focus-out'
  | 'list-navigation'
  | 'escape-key'
  | 'item-press'
  | 'close-press'
  | 'sibling-open'
  | 'cancel-open'
  | 'imperative-action'
  | 'none';

ContextMenu.Root.ChangeEventDetails

type ContextMenuRootChangeEventDetails =
  | {
      reason: 'trigger-hover';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'trigger-focus';
      event: FocusEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'trigger-press';
      event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'outside-press';
      event: MouseEvent | PointerEvent | TouchEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'focus-out';
      event: FocusEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'list-navigation';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'escape-key';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'item-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'close-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'sibling-open';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'cancel-open';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'imperative-action';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    }
  | {
      reason: 'none';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
    };

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Trigger.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Trigger.State, ) => ReactElement) | undefined

data-popup-open

Present when the corresponding context menu is open.

data-pressed

Present when the trigger is pressed.

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

Additional Types

ContextMenu.Trigger.Props

Re-Export of Trigger props as ContextMenuTriggerProps

ContextMenu.Trigger.State

type ContextMenuTriggerState = { open: boolean };

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.

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: ContextMenu.Portal.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Portal.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Portal.State, ) => ReactElement) | undefined

Additional Types

ContextMenu.Portal.Props

Re-Export of Portal props as ContextMenuPortalProps

ContextMenu.Portal.State

type ContextMenuPortalState = {};

Positioner

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

disableAnchorTracking

boolean

false

Name: disableAnchorTracking
Description: Whether to disable the popup from tracking any layout shift of its positioning anchor.
Type: boolean | undefined
Default: false

align

Align

'center'

Name: align
Description: How to align the popup relative to the specified side.
Type: 'start' | 'center' | 'end' | 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: | 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start'; align: 'start' | 'center' | 'end'; 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: | 'top' | 'bottom' | 'left' | 'right' | '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: | 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start'; align: 'start' | 'center' | 'end'; 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 | VirtualElement | React.RefObject<Element | null> | (() => Element | VirtualElement | null) | null | undefined

collisionAvoidance

CollisionAvoidance

—

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

collisionBoundary

Boundary

'clipping-ancestors'

Name: collisionBoundary
Description: An element or a rectangle that delimits the area that the popup is confined to.
Type: Boundary | undefined
Default: 'clipping-ancestors'

collisionPadding

Padding

5

Name: collisionPadding
Description: Additional space to maintain from the edge of the collision boundary.
Type: Padding | 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

'absolute' | 'fixed'

'absolute'

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

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.Positioner.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Positioner.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Positioner.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.Positioner.Props

Re-Export of Positioner props as ContextMenuPositionerProps

ContextMenu.Positioner.State

type ContextMenuPositionerState = {
  open: boolean;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  anchorHidden: boolean;
  nested: boolean;
}

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

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: | 'mouse' | 'touch' | 'pen' | 'keyboard' | '', ) => boolean | void | HTMLElement | null) | undefined

Name: children
Type: React.ReactNode | undefined

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

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

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

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.

Additional Types

Re-Export of Popup props as ContextMenuPopupProps

type ContextMenuPopupState = {
  transitionStatus: TransitionStatus;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  open: boolean;
  nested: boolean;
  instant: 'dismiss' | 'click' | 'group' | undefined;
}

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Arrow.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Arrow.State, ) => ReactElement) | undefined

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-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-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.

Additional Types

ContextMenu.Arrow.Props

Re-Export of Arrow props as ContextMenuArrowProps

ContextMenu.Arrow.State

type ContextMenuArrowState = {
  open: boolean;
  side:
    | 'top'
    | 'bottom'
    | 'left'
    | 'right'
    | 'inline-end'
    | 'inline-start';
  align: 'start' | 'center' | 'end';
  uncentered: boolean;
}

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: | (( event: BaseUIEvent< React.MouseEvent<HTMLDivElement, MouseEvent> >, ) => void) | 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

disabled

boolean

false

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

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Item.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Item.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.Item.Props

Re-Export of Item props as ContextMenuItemProps

ContextMenu.Item.State

type ContextMenuItemState = { disabled: boolean; highlighted: boolean };

LinkItem

A link in the menu that can be used to navigate to a different page or section. Renders an <a> element.

label

string

—

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

closeOnClick

boolean

false

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

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.LinkItem.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.LinkItem.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.LinkItem.State, ) => ReactElement) | undefined

data-highlighted

Present when the link is highlighted.

Attribute	Description	-
`data-highlighted`	Present when the link is highlighted.

Additional Types

ContextMenu.LinkItem.Props

Re-Export of LinkItem props as ContextMenuLinkItemProps

ContextMenu.LinkItem.State

type ContextMenuLinkItemState = { highlighted: boolean };

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: ContextMenu.SubmenuRoot.ChangeEventDetails, ) => void) | undefined

highlightItemOnHover

boolean

true

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

actionsRef

React.RefObject<MenuRoot.Actions | null>

—

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.

close: When specified, the menu can be closed imperatively.
Type: React.RefObject<MenuRoot.Actions | null> | undefined

closeParentOnEsc

boolean

false

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

defaultTriggerId

string | null

—

Name: defaultTriggerId
Description: ID of the trigger that the popover is associated with. This is useful in conjunction with the defaultOpen prop to create an initially open popover.
Type: string | null | undefined

handle

MenuHandle<unknown>

—

Name: handle
Description: A handle to associate the menu with a trigger. If specified, allows external triggers to control the menu’s open state.
Type: MenuHandle<unknown> | undefined

loopFocus

boolean

true

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

onOpenChangeComplete

function

—

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

triggerId

string | null

—

Name: triggerId
Description: ID of the trigger that the popover is associated with. This is useful in conjunction with the open prop to create a controlled popover. There’s no need to specify this prop when the popover is uncontrolled (that is, when the open prop is not set).
Type: string | null | undefined

disabled

boolean

false

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

orientation

MenuRoot.Orientation

'vertical'

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

children

| React.ReactNode 
|  PayloadChildRenderFunction<unknown>

—

Name: children
Description: The content of the popover. This can be a regular React node or a render function that receives the payload of the active trigger.
Type: React.ReactNode | ((arg: { payload: unknown }) => ReactNode)<unknown> | undefined

Additional Types

ContextMenu.SubmenuRoot.Props

Re-Export of SubmenuRoot props as ContextMenuSubmenuRootProps

ContextMenu.SubmenuRoot.State

type ContextMenuSubmenuRootState = {};

ContextMenu.SubmenuRoot.ChangeEventReason

type ContextMenuSubmenuRootChangeEventReason =
  | 'trigger-hover'
  | 'trigger-focus'
  | 'trigger-press'
  | 'outside-press'
  | 'focus-out'
  | 'list-navigation'
  | 'escape-key'
  | 'item-press'
  | 'close-press'
  | 'sibling-open'
  | 'cancel-open'
  | 'imperative-action'
  | 'none';

ContextMenu.SubmenuRoot.ChangeEventDetails

type ContextMenuSubmenuRootChangeEventDetails =
  | {
      reason: 'trigger-hover';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-focus';
      event: FocusEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-press';
      event:
        | MouseEvent
        | PointerEvent
        | TouchEvent
        | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'outside-press';
      event: MouseEvent | PointerEvent | TouchEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'focus-out';
      event: FocusEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'list-navigation';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'escape-key';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'item-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'close-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'sibling-open';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'cancel-open';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'imperative-action';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'none';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }

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: | (( event: BaseUIEvent< React.MouseEvent<HTMLDivElement, MouseEvent> >, ) => void) | 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

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

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.SubmenuTrigger.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.SubmenuTrigger.State, ) => ReactElement) | undefined

data-popup-open

Present when the corresponding submenu is open.

data-highlighted

Present when the submenu trigger is highlighted.

data-disabled

Present when the submenu trigger is disabled.

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

Additional Types

ContextMenu.SubmenuTrigger.Props

Re-Export of SubmenuTrigger props as ContextMenuSubmenuTriggerProps

ContextMenu.SubmenuTrigger.State

type ContextMenuSubmenuTriggerState = { disabled: boolean; highlighted: boolean; open: boolean };

Group

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

children

React.ReactNode

—

Name: children
Description: The content of the component.
Type: React.ReactNode | 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: ContextMenu.Group.State) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.Group.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.Group.State, ) => ReactElement) | undefined

Additional Types

ContextMenu.Group.Props

Re-Export of Group props as ContextMenuGroupProps

ContextMenu.Group.State

type ContextMenuGroupState = {};

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: ContextMenu.GroupLabel.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.GroupLabel.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.GroupLabel.State, ) => ReactElement) | undefined

Additional Types

ContextMenu.GroupLabel.Props

Re-Export of GroupLabel props as ContextMenuGroupLabelProps

ContextMenu.GroupLabel.State

type ContextMenuGroupLabelState = {};

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

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

onValueChange

function

—

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

disabled

boolean

false

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

children

React.ReactNode

—

Name: children
Description: The content of the component.
Type: React.ReactNode | 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: ContextMenu.RadioGroup.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.RadioGroup.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.RadioGroup.State, ) => ReactElement) | undefined

Additional Types

ContextMenu.RadioGroup.Props

Re-Export of RadioGroup props as ContextMenuRadioGroupProps

ContextMenu.RadioGroup.State

type ContextMenuRadioGroupState = { disabled: boolean };

ContextMenu.RadioGroup.ChangeEventReason

type ContextMenuRadioGroupChangeEventReason =
  | 'trigger-hover'
  | 'trigger-focus'
  | 'trigger-press'
  | 'outside-press'
  | 'focus-out'
  | 'list-navigation'
  | 'escape-key'
  | 'item-press'
  | 'close-press'
  | 'sibling-open'
  | 'cancel-open'
  | 'imperative-action'
  | 'none';

ContextMenu.RadioGroup.ChangeEventDetails

type ContextMenuRadioGroupChangeEventDetails =
  | {
      reason: 'trigger-hover';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-focus';
      event: FocusEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-press';
      event:
        | MouseEvent
        | PointerEvent
        | TouchEvent
        | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'outside-press';
      event: MouseEvent | PointerEvent | TouchEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'focus-out';
      event: FocusEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'list-navigation';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'escape-key';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'item-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'close-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'sibling-open';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'cancel-open';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'imperative-action';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'none';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }

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 ContextMenu.RadioGroup when the item is selected.
Type: any

onClick

function

—

Name: onClick
Description: The click handler for the menu item.
Type: | (( event: BaseUIEvent< React.MouseEvent<HTMLDivElement, MouseEvent> >, ) => void) | 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

disabled

boolean

false

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

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

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.RadioItem.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.RadioItem.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.RadioItem.Props

Re-Export of RadioItem props as ContextMenuRadioItemProps

ContextMenu.RadioItem.State

type ContextMenuRadioItemState = { disabled: boolean; highlighted: boolean; checked: boolean };

RadioItemIndicator

Indicates whether the radio item is selected. Renders a <span> 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.RadioItemIndicator.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.RadioItemIndicator.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.RadioItemIndicator.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.RadioItemIndicator.Props

Re-Export of RadioItemIndicator props as ContextMenuRadioItemIndicatorProps

ContextMenu.RadioItemIndicator.State

type ContextMenuRadioItemIndicatorState = {
  checked: boolean;
  disabled: boolean;
  highlighted: boolean;
  transitionStatus: TransitionStatus;
};

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: ContextMenu.CheckboxItem.ChangeEventDetails, ) => void) | undefined

onClick

function

—

Name: onClick
Description: The click handler for the menu item.
Type: | (( event: BaseUIEvent< React.MouseEvent<HTMLDivElement, MouseEvent> >, ) => void) | 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

disabled

boolean

false

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

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.CheckboxItem.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.CheckboxItem.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.CheckboxItem.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.CheckboxItem.Props

Re-Export of CheckboxItem props as ContextMenuCheckboxItemProps

ContextMenu.CheckboxItem.State

type ContextMenuCheckboxItemState = { disabled: boolean; highlighted: boolean; checked: boolean };

ContextMenu.CheckboxItem.ChangeEventReason

type ContextMenuCheckboxItemChangeEventReason =
  | 'trigger-hover'
  | 'trigger-focus'
  | 'trigger-press'
  | 'outside-press'
  | 'focus-out'
  | 'list-navigation'
  | 'escape-key'
  | 'item-press'
  | 'close-press'
  | 'sibling-open'
  | 'cancel-open'
  | 'imperative-action'
  | 'none';

ContextMenu.CheckboxItem.ChangeEventDetails

type ContextMenuCheckboxItemChangeEventDetails =
  | {
      reason: 'trigger-hover';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-focus';
      event: FocusEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'trigger-press';
      event:
        | MouseEvent
        | PointerEvent
        | TouchEvent
        | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'outside-press';
      event: MouseEvent | PointerEvent | TouchEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'focus-out';
      event: FocusEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'list-navigation';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'escape-key';
      event: KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'item-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'close-press';
      event: MouseEvent | PointerEvent | KeyboardEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'sibling-open';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'cancel-open';
      event: MouseEvent;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'imperative-action';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }
  | {
      reason: 'none';
      event: Event;
      cancel: () => void;
      allowPropagation: () => void;
      isCanceled: boolean;
      isPropagationAllowed: boolean;
      trigger: Element | undefined;
      preventUnmountOnClose: () => void;
    }

CheckboxItemIndicator

Indicates whether the checkbox item is ticked. Renders a <span> 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.CheckboxItemIndicator.State, ) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: ContextMenu.CheckboxItemIndicator.State, ) => React.CSSProperties | undefined) | 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: ContextMenu.CheckboxItemIndicator.State, ) => ReactElement) | undefined

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.

Additional Types

ContextMenu.CheckboxItemIndicator.Props

Re-Export of CheckboxItemIndicator props as ContextMenuCheckboxItemIndicatorProps

ContextMenu.CheckboxItemIndicator.State

type ContextMenuCheckboxItemIndicatorState = {
  checked: boolean;
  disabled: boolean;
  highlighted: boolean;
  transitionStatus: TransitionStatus;
};

Separator

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

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: SeparatorState) => string | undefined) | undefined

style

React.CSSProperties | function

—

Name: style
Type: | React.CSSProperties | (( state: SeparatorState, ) => React.CSSProperties | undefined) | 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: SeparatorState, ) => ReactElement) | undefined

Additional Types

ContextMenu.Separator.Props

Re-Export of Separator props as ContextMenuSeparatorProps

ContextMenu.Separator.State

type ContextMenuSeparatorState = {
  orientation: 'horizontal' | 'vertical';
}

Context Menu

Anatomy

Examples

Nested menu

API reference

Root

Additional Types

Trigger

Additional Types

Portal

Additional Types

Positioner

Additional Types

Additional Types

Arrow

Additional Types

Item

Additional Types

LinkItem

Additional Types

SubmenuRoot

Additional Types

SubmenuTrigger

Additional Types

Group

Additional Types

GroupLabel

Additional Types

RadioGroup

Additional Types

RadioItem

Additional Types

RadioItemIndicator

Additional Types

CheckboxItem

Additional Types

CheckboxItemIndicator

Additional Types

Separator

Additional Types