Whether the checkbox item is currently ticked.

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

Whether to close the menu when the item is clicked.

Whether the checkbox item is initially ticked.

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

Whether the component should ignore user interaction.

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.

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

The click handler for the menu item.

The visual style of the component.

The content of the component.

Whether to close the menu when the item is clicked.

Whether the component should ignore user interaction.

Whether to indent the item so its text lines up with items that have an icon.

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.

The click handler for the menu item.

The visual style of the component.

Whether to indent the label so it lines up with items that have an icon.

How the calendar lines up with the trigger along that side.

Additional offset along the alignment axis, in pixels.

The content of the component.

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 copy button the tooltip and toast open on.

The gap between the trigger and the calendar, in pixels.

A parent element to render the portal element into.

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

The content of the component.

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

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

Whether the component should ignore user interaction.

Function called when the selected value changes.

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

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

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.

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.

The click handler for the menu item.

The orientation of the separator.

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.

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 menu is initially open.

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

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.

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 when the menu is opened or closed.

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

Whether the menu is currently open.

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

How the calendar lines up with the trigger along that side.

Additional offset along the alignment axis, in pixels.

The content of the component.

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.

The gap between the trigger and the calendar, in pixels.

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.

Replaces this icon. Accepts any node; null renders no icon. Takes precedence over IconProvider.

Whether to indent the item so its text lines up with items that have an icon.

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.

The click handler for the menu item.

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