ContextMenu

Whether the menu is currently open.

Whether the menu is initially open.

To render a controlled menu, use the open prop instead.

Deprecated. This prop has no effect on Context Menu.

Whether the component should ignore user interaction.

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

Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.

The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.

A ref to imperative actions.

• unmount: Ends the closing phase of the menu after an externally controlled closing animation finishes. Call preventUnmountOnClose() in onOpenChange first, otherwise the menu completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.
• close: Closes the menu imperatively when called.

Event handler called when the menu is opened or closed.

Callback fired when an item is highlighted or unhighlighted. Receives the highlighted item element (or undefined if no item is highlighted) and details containing the reason for the change, the event, and the item's text label. The reason can be:

• 'keyboard': the highlight changed due to keyboard navigation.
• 'pointer': the highlight changed due to pointer hovering. The event may be a MouseEvent rather than a PointerEvent.
• 'none': the highlight changed for another reason, such as automatic highlighting while filtering, the item list changing, or the popup opening or closing.

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

How to align the popup relative to the specified side.

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.

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.

Which side of the anchor element to align the popup against. May automatically change to avoid collisions.

Submenus default to 'inline-end'.

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.

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.

Whether the checkbox item is currently ticked.

To render an uncontrolled checkbox item, use the defaultChecked prop instead.

Whether the checkbox item is initially ticked.

To render a controlled checkbox item, use the checked prop instead.

Whether to close the menu when the item is clicked.

Whether the component should ignore user interaction.

Indents the text to line up with items that have an icon or indicator.

Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.

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.

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.

Event handler called when the checkbox item is ticked or unticked.

The click handler for the menu item.

Value of the radio item. This is the value that will be set in the MenuRadioGroup when the item is selected.

Whether to close the menu when the item is clicked.

Whether the component should ignore user interaction.

Indents the text to line up with items that have an icon or indicator.

Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.

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.

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.

The click handler for the menu item.

Indents the text to line up with items that have an icon or indicator.

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.

The orientation of the separator.

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.

The content of the component.

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.

A parent element to render the portal element into.

Whether to keep the portal mounted in the DOM while the popup is hidden.

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.

Whether the menu is currently open.

Whether the menu is initially open.

To render a controlled menu, use the open prop instead.

The content of the submenu.

When in a submenu, determines whether pressing the Escape key closes the entire menu, or only the current child menu.

Whether the component should ignore user interaction.

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

Whether to loop keyboard focus back to the first item when the end of the list is reached while using the arrow keys.

The visual orientation of the menu. Controls whether roving focus uses up/down or left/right arrow keys.

A ref to imperative actions.

• unmount: Ends the closing phase of the menu after an externally controlled closing animation finishes. Call preventUnmountOnClose() in onOpenChange first, otherwise the menu completes closing on its own. Whether it leaves the DOM is decided by keepMounted on the portal.
• close: Closes the menu imperatively when called.

Event handler called when the menu is opened or closed.

Callback fired when an item is highlighted or unhighlighted. Receives the highlighted item element (or undefined if no item is highlighted) and details containing the reason for the change, the event, and the item's text label. The reason can be:

• 'keyboard': the highlight changed due to keyboard navigation.
• 'pointer': the highlight changed due to pointer hovering. The event may be a MouseEvent rather than a PointerEvent.
• 'none': the highlight changed for another reason, such as automatic highlighting while filtering, the item list changing, or the popup opening or closing.

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

How to align the popup relative to the specified side.

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.

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.

Which side of the anchor element to align the popup against. May automatically change to avoid collisions.

Submenus default to 'inline-end'.

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.

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.

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

Requires the openOnHover prop.

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

Requires the openOnHover prop.

Whether the component should ignore user interaction.

Indents the text to line up with items that have an icon or indicator.

Overrides the text used for keyboard text navigation and filtering. Falls back to the rendered text when not provided.

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.

Whether the menu should also open when the trigger is hovered.

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.

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

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

The uncontrolled value of the radio item that should be initially selected.

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

The content of the component.

Whether the component should ignore user interaction.

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.

Function called when the selected value changes.