AriaMenuProps
type AriaMenuProps = object;
Properties
| Property | Type | Description |
|---|---|---|
items | AriaMenuItem[] | An array of menu items. |
button | ReactElement | The react element that triggers the menu. |
renderButton? | (triggerButton) => ReactNode | Optionally wraps the rendered menu trigger. Example renderButton={triggerButton => ( <Tooltip text="Settings">{triggerButton}</Tooltip> )} |
headerContent? | ReactElement | Optional content to show above the menu items. |
onOpenChange? | (isOpen) => void | Callback function called when the menu open state changes. |
testId? | string | The test id for the menu. |
colorScheme? | ColorScheme | The color scheme for the menu. |
popoverPlacement? | Placement | The placement of the popover. |
popoverOffset? | number | The offset for the popover. |
menuClassName? | string | The class name for the menu. |
itemClassName? | string | The class name for the menu item. |
backButtonLabel? | string | Default aria label for the back button rendered at the top of a submenu. |
onGoBack? | () => void | Callback function called when the user navigates back one level via the back button rendered at the top of a submenu. |
showSubMenuIndicator? | boolean | Whether to show the chevron indicator on menu items that open a submenu. Defaults to true. |