# Context Menu (/cloud/headless/context-menu) {/* Generated by scripts/sync-base-ui-reference.mjs. Edit the script, not this file. */} ## In Nyte [#in-nyte] ```ts title="Import" import { ContextMenu } from "@nyte-ai/ui/context-menu"; ``` `@nyte-ai/ui/context-menu` re-exports the Base UI namespace unchanged. There is no Nyte styling on this subpath; the consumer owns every class, StyleX style, and layout decision. Base UI owns the interaction model, keyboard handling, focus management, and ARIA below. Consumed by: * `desktop/src/renderer/src/components/menu.tsx` The rest of this page is Base UI's documentation for `@base-ui/react/context-menu`, reproduced verbatim under the MIT license, © Material-UI SAS. Component paths in examples refer to the Base UI package; in Nyte, import from the subpath above. ## Usage guidelines [#usage-guidelines] * **Use context menus as an enhancement**: Don't make a context menu the only way to perform actions. Users may not discover or be able to open a context menu, especially on touch devices or with assistive technology. Always provide visible controls for the actions that are available in the context menu. ## Anatomy [#anatomy] Import the components and place them together: ```jsx title="Anatomy" import { ContextMenu } from '@base-ui/react/context-menu'; ; ``` ## Examples [#examples] [Menu](/react/components/menu#examples) displays additional demos, many of which apply to the context menu as well. ### Using with Menu [#using-with-menu] A context menu should supplement a primary way to perform the same actions. This image card exposes actions through a visible menu button and reuses them in the context menu for right-click and long-press users. ### Nested menu [#nested-menu] To create a submenu, create a `` inside the parent context menu. Use the `` part for the menu item that opens the nested menu. ## API reference [#api-reference] ### Root [#root] A component that creates a context menu activated by right clicking or long pressing. Doesn't render its own HTML element. **Root Props:** | Prop | Type | Default | Description | | :------------------- | :----------------------------------------------------------------------------- | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | defaultOpen | `boolean` | `false` | Whether the menu is initially open. To render a controlled menu, use the `open` prop instead. | | open | `boolean` | - | Whether the menu is currently open. | | onOpenChange | `((open: boolean, eventDetails: ContextMenu.Root.ChangeEventDetails) => void)` | - | Event handler called when the menu is opened or closed. | | highlightItemOnHover | `boolean` | `true` | Whether moving the pointer over items should highlight them. Disabling this prop allows CSS `:hover` to be differentiated from the `:focus` (`data-highlighted`) state. | | actionsRef | `React.RefObject` | - | A ref to imperative actions. `unmount`: Manually unmounts the menu. Call this after any externally controlled closing animation finishes.`close`: When specified, the menu can be closed imperatively. | | loopFocus | `boolean` | `true` | Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys. | | onOpenChangeComplete | `((open: boolean) => void)` | - | Event handler called after any animations complete when the menu is opened or closed. | | disabled | `boolean` | `false` | Whether the component should ignore user interaction. | | orientation | `MenuRoot.Orientation` | `'vertical'` | The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys. | | children | `React.ReactNode` | - | - | ### Root.Props [#rootprops] Re-export of [Root](#root) props. ### Root.State [#rootstate] ```typescript type ContextMenuRootState = {}; ``` ### Root.Actions [#rootactions] ```typescript type ContextMenuRootActions = { unmount: () => void; close: () => void }; ``` ### Root.ChangeEventReason [#rootchangeeventreason] ```typescript 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'; ``` ### Root.ChangeEventDetails [#rootchangeeventdetails] ```typescript type ContextMenuRootChangeEventDetails = ( | { reason: 'trigger-hover'; event: MouseEvent } | { reason: 'trigger-focus'; event: FocusEvent } | { reason: 'trigger-press'; event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent } | { reason: 'outside-press'; event: MouseEvent | PointerEvent | TouchEvent } | { reason: 'focus-out'; event: FocusEvent | KeyboardEvent } | { reason: 'list-navigation'; event: KeyboardEvent } | { reason: 'escape-key'; event: KeyboardEvent } | { reason: 'item-press'; event: MouseEvent | PointerEvent | KeyboardEvent } | { reason: 'close-press'; event: MouseEvent | PointerEvent | KeyboardEvent } | { reason: 'sibling-open'; event: Event } | { reason: 'cancel-open'; event: MouseEvent } | { reason: 'imperative-action'; event: Event } | { reason: 'none'; event: Event } ) & { /** Cancels Base UI from handling the event. */ cancel: () => void; /** Allows the event to propagate in cases where Base UI will stop the propagation. */ allowPropagation: () => void; /** Indicates whether the event has been canceled. */ isCanceled: boolean; /** Indicates whether the event is allowed to propagate. */ isPropagationAllowed: boolean; /** The element that triggered the event, if applicable. */ trigger: Element | undefined; }; ``` ### Trigger [#trigger] An area that opens the menu on right click or long press. Renders a `
` element. **Trigger Props:** | Prop | Type | Default | Description | | :-------- | :------------------------------------------------------------------------------------------------ | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: ContextMenu.Trigger.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Trigger.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Trigger.State) => ReactElement)` | - | 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. | **Trigger Data Attributes:** | Attribute | Type | Description | | :-------------- | :--- | :--------------------------------------------------- | | data-popup-open | - | Present when the corresponding context menu is open. | | data-pressed | - | Present when the corresponding context menu is open. | ### Trigger.Props [#triggerprops] Re-export of [Trigger](#trigger) props. ### Trigger.State [#triggerstate] ```typescript type ContextMenuTriggerState = { /** Whether the context menu is currently open. */ open: boolean; }; ``` ### Portal [#portal] A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to ``. Renders a `
` element. **Portal Props:** | Prop | Type | Default | Description | | :---------- | :----------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | container | `HTMLElement \| ShadowRoot \| React.RefObject \| null` | - | A parent element to render the portal element into. | | className | `string \| ((state: ContextMenu.Portal.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Portal.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | keepMounted | `boolean` | `false` | Whether to keep the portal mounted in the DOM while the popup is hidden. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Portal.State) => ReactElement)` | - | 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. | ### Portal.Props [#portalprops] Re-export of [Portal](#portal) props. ### Portal.State [#portalstate] ```typescript type ContextMenuPortalState = {}; ``` ### Backdrop [#backdrop] An overlay displayed beneath the menu popup. Renders a `
` element. **Backdrop Props:** | Prop | Type | Default | Description | | :-------- | :------------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: ContextMenu.Backdrop.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Backdrop.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Backdrop.State) => ReactElement)` | - | 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. | **Backdrop Data Attributes:** | Attribute | Type | Description | | :------------------ | :--- | :----------------------------------------- | | data-open | - | Present when the menu is open. | | data-closed | - | Present when the menu is closed. | | data-starting-style | - | Present when the menu begins animating in. | | data-ending-style | - | Present when the menu is animating out. | ### Backdrop.Props [#backdropprops] Re-export of [Backdrop](#backdrop) props. ### Backdrop.State [#backdropstate] ```typescript type ContextMenuBackdropState = { /** Whether the menu is currently open. */ open: boolean; /** The transition status of the component. */ transitionStatus: TransitionStatus; }; ``` ### Positioner [#positioner] Positions the context menu popup against the pointer or a custom anchor. Renders a `
` element. **Positioner Props:** | Prop | Type | Default | Description | | :-------------------- | :------------------------------------------------------------------------------------------------------------------- | :--------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | disableAnchorTracking | `boolean` | `false` | Whether to disable the popup from tracking any layout shift of its positioning anchor. | | align | `Align` | `'start'` | How to align the popup relative to the specified side. | | alignOffset | `number \| OffsetFunction` | - | 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. Defaults to `2` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`. | | side | `Side` | `'bottom'` | Which side of the anchor element to align the popup against. May automatically change to avoid collisions. Submenus default to `'inline-end'`. | | sideOffset | `number \| OffsetFunction` | - | 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. Defaults to `-5` for root context menus when `side` is not specified and `align` is not `'center'`. Otherwise, it defaults to `0`. | | arrowPadding | `number` | - | Minimum distance to maintain between the arrow and the edges of the popup. Root context menus always use `0`. Submenus default to `5`. | | anchor | `Element \| VirtualElement \| React.RefObject \| (() => Element \| VirtualElement \| null) \| null` | - | An element to position the popup against. By default, root context menus are positioned at the pointer, and submenus are positioned against their trigger. | | collisionAvoidance | `CollisionAvoidance` | - | Determines how to handle collisions when positioning the popup. `side` controls overflow on the preferred placement axis (`top`/`bottom` or `left`/`right`): `'flip'`: keep the requested side when it fits; otherwise try the opposite side (`top` and `bottom`, or `left` and `right`).`'shift'`: never change side; keep the requested side and move the popup within the clipping boundary so it stays visible.`'none'`: do not correct side-axis overflow. `align` controls overflow on the alignment axis (`start`/`center`/`end`): `'flip'`: keep side, but swap `start` and `end` when the requested alignment overflows.`'shift'`: keep side and requested alignment, then nudge the popup along the alignment axis to fit.`'none'`: do not correct alignment-axis overflow. `fallbackAxisSide` controls fallback behavior on the perpendicular axis when the preferred axis cannot fit: `'start'`: allow perpendicular fallback and try the logical start side first (`top` before `bottom`, or `left` before `right` in LTR).`'end'`: allow perpendicular fallback and try the logical end side first (`bottom` before `top`, or `right` before `left` in LTR).`'none'`: do not fallback to the perpendicular axis. When `side` is `'shift'`, explicitly setting `align` only supports `'shift'` or `'none'`. If `align` is omitted, it defaults to `'flip'`. | | collisionBoundary | `Boundary` | `'clipping-ancestors'` | An element or a rectangle that delimits the area that the popup is confined to. | | collisionPadding | `Padding` | `5` | Additional space to maintain from the edge of the collision boundary. | | sticky | `boolean` | `false` | Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. | | className | `string \| ((state: ContextMenu.Positioner.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Positioner.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Positioner.State) => ReactElement)` | - | 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. | **`alignOffset` Prop Example:** ```jsx { return side === 'top' || side === 'bottom' ? anchor.width : anchor.height; }} /> ``` **`sideOffset` Prop Example:** ```jsx { return side === 'top' || side === 'bottom' ? anchor.height : anchor.width; }} /> ``` **`collisionAvoidance` Prop Example:** ```jsx ``` **Positioner Data Attributes:** | Attribute | Type | 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 | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to the specified side. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the anchor. | **Positioner CSS Variables:** | Variable | Type | Description | | :-------------------- | :------- | :----------------------------------------------------------------------------------------------------------------------------- | | `--anchor-height` | `number` | The anchor's height. | | `--anchor-width` | `number` | The anchor's width. | | `--available-height` | `number` | The available height between the anchor and the edge of the viewport. | | `--available-width` | `number` | The available width between the anchor and the edge of the viewport. | | `--positioner-height` | `number` | The height of the menu's positioner. It is important to set `height` to this value when using CSS to animate size changes. | | `--positioner-width` | `number` | The width of the menu's positioner. It is important to set `width` to this value when using CSS to animate size changes. | | `--transform-origin` | `string` | The coordinates that this element is anchored to. Used for animations and transitions. | ### Positioner.Props [#positionerprops] Re-export of [Positioner](#positioner) props. ### Positioner.State [#positionerstate] ```typescript type ContextMenuPositionerState = { /** Whether the menu is currently open. */ open: boolean; /** The side of the anchor the component is placed on. */ side: Side; /** The alignment of the component relative to the anchor. */ align: Align; /** Whether the anchor element is hidden. */ anchorHidden: boolean; /** Whether the component is nested. */ nested: boolean; /** Whether CSS transitions should be disabled. */ instant: string | undefined; }; ``` ### Popup [#popup] A container for the menu items. Renders a `
` element. **Popup Props:** | Prop | Type | Default | Description | | :--------- | :---------------------------------------------------------------------------------------------------------------------------- | :------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | finalFocus | `boolean \| React.RefObject \| ((closeType: InteractionType) => boolean \| void \| HTMLElement \| null)` | - | 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. | | children | `React.ReactNode` | - | - | | className | `string \| ((state: ContextMenu.Popup.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Popup.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Popup.State) => ReactElement)` | - | 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. | **Popup Data Attributes:** | Attribute | Type | Description | | :------------------ | :------------------------------------------------------------------------- | :------------------------------------------------------------------- | | data-open | - | Present when the menu is open. | | data-closed | - | Present when the menu is closed. | | data-align | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to specified side. | | data-instant | `'click' \| 'dismiss' \| 'group' \| 'trigger-change'` | Present if animations should be instant. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the anchor. | | data-starting-style | - | Present when the menu begins animating in. | | data-ending-style | - | Present when the menu is animating out. | ### Popup.Props [#popupprops] Re-export of [Popup](#popup) props. ### Popup.State [#popupstate] ```typescript type ContextMenuPopupState = { /** The transition status of the component. */ transitionStatus: TransitionStatus; /** The side of the anchor the component is placed on. */ side: Side; /** The alignment of the component relative to the anchor. */ align: Align; /** Whether the menu is currently open. */ open: boolean; /** Whether the component is nested. */ nested: boolean; /** Whether transitions should be skipped. */ instant: 'dismiss' | 'click' | 'group' | 'trigger-change' | undefined; }; ``` ### Arrow [#arrow] Displays an element positioned against the menu anchor. Renders a `
` element. **Arrow Props:** | Prop | Type | Default | Description | | :-------- | :---------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: ContextMenu.Arrow.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component's state. | | style | `React.CSSProperties \| ((state: ContextMenu.Arrow.State) => React.CSSProperties \| undefined)` | - | Style applied to the element, or a function that returns a style object based on the component's state. | | render | `ReactElement \| ((props: HTMLProps, state: ContextMenu.Arrow.State) => ReactElement)` | - | 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. | **Arrow Data Attributes:** | Attribute | Type | 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 | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to specified side. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the anchor. | ### Arrow\.Props [#arrowprops] Re-export of [Arrow](#arrow) props. ### Arrow\.State [#arrowstate] ```typescript type ContextMenuArrowState = { /** Whether the menu is currently open. */ open: boolean; /** The side of the anchor the component is placed on. */ side: Side; /** The alignment of the component relative to the anchor. */ align: Align; /** Whether the arrow cannot be centered on the anchor. */ uncentered: boolean; }; ``` ### Item [#item] An individual interactive item in the menu. Renders a `
` element. **Item Props:** | Prop | Type | Default | Description | | :----------- | :--------------------------------------------------------------------------------------------- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | label | `string` | - | Overrides the text label to use when the item is matched during keyboard text navigation. | | onClick | `((event: BaseUIEvent>) => void)` | - | The click handler for the menu item. | | closeOnClick | `boolean` | `true` | Whether to close the menu when the item is clicked. | | nativeButton | `boolean` | `false` | Whether the component renders a native `