ant-design/components/menu/index.en-US.md
2017-10-25 10:25:44 +08:00

3.1 KiB

category cols type title
Components 1 Navigation Menu

Menu list of Navigation.

When To Use

Navigation menu is important for a website, it helps users jump from one site section to another quickly. Mostly, it includes top navigation and side navigation. Top navigation provides all the category and functions of the website. Side navigation provides the Multi-level structure of the website.

More layouts with navigation: layout.

API

<Menu>
  <Menu.Item>Menu</Menu.Item>
  <SubMenu title="SubMenu">
    <Menu.Item>SubMenuItem</Menu.Item>
  </SubMenu>
</Menu>

Menu

Param Description Type Default value
defaultOpenKeys array with the keys of default opened sub menus
defaultSelectedKeys array with the keys of default selected menu items string[]
inlineCollapsed specifies the collapsed status when menu is inline mode boolean -
inlineIndent indent px of inline menu item on each level number 24
mode type of the menu; vertical, horizontal, and inline modes are supported string: vertical | horizontal | inline vertical
multiple Allow selection of multiple items boolean false
openKeys array with the keys of currently opened sub menus string[]
selectable Allow to be selected boolean true
selectable allow selecting menu items boolean true
selectedKeys array with the keys of currently selected menu items string[]
style style of the root node object
theme color theme of the menu string: light dark light
onClick callback executed when a menu item is clicked function({ item, key, keyPath }) -
onDeselect callback executed when a menu item is deselected, only supported for multiple mode function({ item, key, selectedKeys }) -
onOpenChange called when open/close sub menu function(openKeys: string[]) noop
onSelect callback executed when a menu item is selected function({ item, key, selectedKeys }) none

More options in rc-menu

Menu.Item

Param Description Type Default value
disabled whether menu item is disabled or not boolean false
key unique id of the menu item string

Menu.SubMenu

Param Description Type Default value
children sub menus or sub menu items Array<MenuItem|SubMenu>
disabled whether sub menu is disabled or not boolean false
key unique id of the sub menu string
title title of the sub menu string|ReactNode
onTitleClick callback executed when the sub menu title is clicked function({ key, domEvent })

Menu.ItemGroup

Param Description Type Default value
children sub menu items MenuItem[]
title title of the group string|ReactNode

Menu.Divider

Divider line in between menu items, only used in vertical popup Menu or Dropdown Menu.