ant-design/components/menu/index.en-US.md
MadCcc cdf9b4660f
refactor: menu token rename (#42848)
* refactor: menu token rename

* chore: update snapshot

* chore: UPDATE TEST CASE

* fix: fix gap as 4px

* fix: popup transform origin
2023-06-06 16:11:18 +08:00

7.5 KiB
Raw Blame History

category group title cover coverDark
Components Navigation Menu https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*KeyQQL5iKkkAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*Vn4XSqJFAxcAAAAAAAAAAAAADrJ8AQ/original

A versatile menu for navigation.

When To Use

Navigation is an important part of any website, as a good navigation setup allows users to move around the site quickly and efficiently. Ant Design offers two navigation options: top and side. Top navigation provides all the categories and functions of the website. Side navigation provides the multi-level structure of the website.

More layouts with navigation: Layout.

Notes for developers

  • Menu is rendered as a ul element, so it only supports li and script-supporting elements as children nodes。Your customized node should be wrapped by Menu.Item.
  • Menu needs to collect its node structure, so its children should be Menu.* or encapsulated HOCs.

Examples

Top Navigation Top Navigation (dark) Inline menu Collapsed inline menu Open current submenu only Vertical menu Menu Themes Sub-menu theme Switch the menu type Style debug Menu v4 Component Token

API

Menu

Param Description Type Default value Version
defaultOpenKeys Array with the keys of default opened sub menus string[] -
defaultSelectedKeys Array with the keys of default selected menu items string[] -
expandIcon custom expand icon of submenu ReactNode | (props: SubMenuProps & { isSubMenu: boolean }) => ReactNode - 4.9.0
forceSubMenuRender Render submenu into DOM before it becomes visible boolean false
inlineCollapsed Specifies the collapsed status when menu is inline mode boolean -
inlineIndent Indent (in pixels) of inline menu items on each level number 24
items Menu item content ItemType[] - 4.20.0
mode Type of menu vertical | horizontal | inline vertical
multiple Allows selection of multiple items boolean false
openKeys Array with the keys of currently opened sub-menus string[] -
overflowedIndicator Customized the ellipsis icon when menu is collapsed horizontally ReactNode <EllipsisOutlined />
selectable Allows selecting menu items boolean true
selectedKeys Array with the keys of currently selected menu items string[] -
style Style of the root node CSSProperties -
subMenuCloseDelay Delay time to hide submenu when mouse leaves (in seconds) number 0.1
subMenuOpenDelay Delay time to show submenu when mouse enters, (in seconds) number 0
theme Color theme of the menu light | dark light
triggerSubMenuAction Which action can trigger submenu open/close hover | click hover
onClick Called when a menu item is clicked function({ item, key, keyPath, domEvent }) -
onDeselect Called when a menu item is deselected (multiple mode only) function({ item, key, keyPath, selectedKeys, domEvent }) -
onOpenChange Called when sub-menus are opened or closed function(openKeys: string[]) -
onSelect Called when a menu item is selected function({ item, key, keyPath, selectedKeys, domEvent }) -

More options in rc-menu

ItemType

type ItemType = MenuItemType | SubMenuType | MenuItemGroupType | MenuDividerType;

MenuItemType

Param Description Type Default value Version
danger Display the danger style boolean false
disabled Whether menu item is disabled boolean false
icon The icon of the menu item ReactNode -
key Unique ID of the menu item string -
label Menu label ReactNode -
title Set display title for collapsed item string -

SubMenuType

Property Description Type Default value Version
children Sub-menus or sub-menu items ItemType[] -
disabled Whether sub-menu is disabled boolean false
icon Icon of sub menu ReactNode -
key Unique ID of the sub-menu string -
label Menu label ReactNode -
popupClassName Sub-menu class name, not working when mode="inline" string -
popupOffset Sub-menu offset, not working when mode="inline" [number, number] -
theme Color theme of the SubMenu (inherits from Menu by default) light | dark -
onTitleClick Callback executed when the sub-menu title is clicked function({ key, domEvent }) -

MenuItemGroupType

Define type as group to make as group:

const groupItem = {
  type: 'group', // Must have
  label: 'My Group',
  children: [],
};
Param Description Type Default value Version
children Sub-menu items MenuItemType[] -
label The title of the group ReactNode -

MenuDividerType

Divider line in between menu items, only used in vertical popup Menu or Dropdown Menu. Need define the type as divider

const dividerItem = {
  type: 'divider', // Must have
};
Param Description Type Default value Version
dashed Whether line is dashed boolean false

FAQ

Why will Menu's children be rendered twice?

Menu collects structure info with twice-render to support HOC usage. Merging into one render may cause the logic to become much more complex. Contributions to help improve the collection logic are welcomed.

Why Menu do not responsive collapse in Flex layout?

Menu will render fully item in flex layout and then collapse it. You need tell flex not consider Menu width to enable responsive (online demo):

<div style={{ flex }}>
  <div style={{ ... }}>Some Content</div>
  <Menu style={{ minWidth: 0, flex: "auto" }} />
</div>

Design Token