This is version 4 beta of Forma 36Go back to last stable version 3
Forma 36

Menu

Menu is a component that offers a list of choices to the user, such as a set of actions or links. Menu uses Popover component as a base.

Table of contents

How to use Menu

You can use following components to build a menu:

  1. <Menu>: The main wrapper that provides nested components with all the context and state.
  2. <Menu.Trigger> The wrapper for the menu list trigger. Must be a direct child of <Menu>. NOTE: 🚨 Ensure that the component that you pass accepts ref. Consider using forwardRef for functional components.
  3. <Menu.List>: The wrapper for the menu items. Must be a direct child of <Menu>.
  4. <Menu.Item> The trigger that handles menu selection. Must be a direct child of <Menu.List>.
  5. <Menu.Divider> A visual separator for menu items.
  6. <Menu.SectionTitle> A title that you can use in the menu list.
  7. <Menu.ListHeader> The wrapper for one menu item that will be sticked to the top of the menu list. <Menu.Item> must be provided as a child.
  8. <Menu.ListFooter> The wrapper for one menu item that will be sticked to the bottom of the menu list. <Menu.Item> must be provided as a child.
  9. <Menu.Submenu> The wrapper for for submenu components. Structure of the children remains the same like in <Menu>, except you should use <Menu.SubmenuTrigger> instead of <Menu.Trigger>.
  10. <Menu.SubmenuTrigger> The wrapper for the submenu list trigger. Must be a direct child of <Menu.Submenu>.

Code examples

Basic

With simple Button as a trigger

With Menu.SectionTitle and Menu.Divider

Open by default

Controlled Menu

By default the Menu component is uncontrolled. So when user clicks on the trigger, the menu opens/closes. But you can control it by passing isOpen prop and onClose, onOpen callbacks.

Controlled Menu with custom trigger onClick callback

In most cases, you will use the controlled approach. But if you have to provide your own toggle menu logic on the trigger component, you can do this by providing onClick callback on trigger component and omitting onOpen callback on the Menu component.

With Menu list maximum height

With disabled items

<Router>
<Menu>
<Menu.Trigger>
<IconButton
variant="secondary"
icon={<MenuIcon />}
aria-label="toggle menu"
/>
</Menu.Trigger>
<Menu.List>
<Link to="/" component={Menu.Item} as="a">
Home
</Link>
<Link to="/about" component={Menu.Item} as="a">
About
</Link>
<Link to="/other" component={Menu.Item} as="a">
Other
</Link>
</Menu.List>
</Menu>
</Router>

With predefined focused menu item

With submenu

By default props like closeOnSelect, closeOnBlur, closeOnEsc that you pass to Menu will be shared to all submenus But you can redefine them on any submenu by passing those props directly to that Submenu.

Content recommendations

  • Use an interactive element such as button for Menu.Trigger

Accessibility

  • When the menu is opened, focus is moved to the first menu item. If you set autoFocusto false, it will not move the focus.
  • When the menu is closed, focus returned back to the trigger element.
  • You can use arrow keys (ArrowUp and ArrowDown) to navigate through menu items.
  • When the menu is open, click on Esc key will close the popover. If you set closeOnEsc to false, it will not close.
  • When the menu is open, click outside menu or blurring out will close the menu. If you set closeOnBlur to false, it will not close.
  • All the necessary a11y attributes for Menu.List, Menu.Trigger and Menu.Item are provided.

Props

NameRequiredDefaultTypeDescription
closeOnBlurtrue
false
true
If true, the menu will close when you blur out it by clicking outside Note: This prop will be propagated to all submenus, unless you will override it with props on submenu itself
closeOnEsctrue
false
true
If true, the menu will close when you hit the Esc key Note: This prop will be propagated to all submenus, unless you will override it with props on submenu itself
closeOnSelecttrue
false
true
If `true`, the Menu will close when a menu item is clicked Note: This prop will be propagated to all submenus, unless you will override it with props on submenu itself
defaultIsOpen
false
true
If `true`, the Menu will be initially opened.
isAutoalignmentEnabledtrue
false
true
Boolean to control if popover is allowed to change its placement automatically based on available space in the viewport. For example: If you set placement prop to bottom, but there isn't enough space to position the popover in that direction, it will change the popper placement to top. As soon as enough space is detected, the placement will be reverted to the defined one. If you want the popover to strictly follow the placement prop you should set this prop to false.
isFullWidthfalse
false
true
Boolean to determine if the Popover should be the same width as the trigger element
isOpen
false
true
If `true`, the Menu will be opened in controlled mode. By default the Menu is uncontrolled
offset[1, 4][number, number]The `X-axis` and `Y-axis` offset to position popper element from its trigger element. `[X, Y]`
onClose() => voidCallback fired when the Menu closes
onOpen() => voidCallback fired when the Menu opens
placementbottom-startPlacementDetermines the preferred position of the Popover. This position is not guaranteed, as the Popover might be moved to fit the viewport
usePortaltrue
false
true
Boolean to control whether or not to render the Popover in a React Portal. Rendering content inside a Portal allows the Popover to escape the bounds of its parent while still being positioned correctly. Using a Portal is necessary if an ancestor of the Popover hides overflow.
childrenrequiredReactNode
NameRequiredDefaultTypeDescription
isInitiallyFocused
false
true
Sets focus on item
asHTML Tag or React Component, e.g. div, span, etc.
childrenReactNode
classNamestringCSS class to be appended to the root element
styleCSSPropertiesAccepts a JavaScript object with camelCased properties rather than a CSS string
testIdstringA [data-test-id] attribute used for testing purposes
NameRequiredDefaultTypeDescription
childrenReactNode
classNamestringCSS class to be appended to the root element
styleCSSPropertiesAccepts a JavaScript object with camelCased properties rather than a CSS string
testIdstringA [data-test-id] attribute used for testing purposes