Skip to main content

AriaMenuProps

type AriaMenuProps = object;

Properties​

PropertyTypeDescription
itemsAriaMenuItem[]An array of menu items.
buttonReactElementThe react element that triggers the menu.
renderButton?(triggerButton) => ReactNodeOptionally wraps the rendered menu trigger. Example renderButton={triggerButton => ( <Tooltip text="Settings">{triggerButton}</Tooltip> )}
headerContent?ReactElementOptional content to show above the menu items.
onOpenChange?(isOpen) => voidCallback function called when the menu open state changes.
testId?stringThe test id for the menu.
colorScheme?ColorSchemeThe color scheme for the menu.
popoverPlacement?PlacementThe placement of the popover.
popoverOffset?numberThe offset for the popover.
menuClassName?stringThe class name for the menu.
itemClassName?stringThe class name for the menu item.
backButtonLabel?stringDefault aria label for the back button rendered at the top of a submenu.
onGoBack?() => voidCallback function called when the user navigates back one level via the back button rendered at the top of a submenu.
showSubMenuIndicator?booleanWhether to show the chevron indicator on menu items that open a submenu. Defaults to true.