2016-03-31 14:17:09 +08:00
---
category: Components
cols: 1
2018-11-04 16:20:35 +08:00
type: 导航
2016-08-26 15:07:46 +08:00
title: Menu
subtitle: 导航菜单
2020-05-31 11:48:34 +08:00
cover: https://gw.alipayobjects.com/zos/alicdn/3XZcjGpvK/Menu.svg
2016-03-31 14:17:09 +08:00
---
2015-08-01 14:08:04 +08:00
2015-08-07 12:20:21 +08:00
为页面和功能提供导航的菜单列表。
2015-08-06 16:49:54 +08:00
## 何时使用
2015-08-07 12:20:21 +08:00
导航菜单是一个网站的灵魂,用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航,顶部导航提供全局性的类目和功能,侧边导航提供多级结构来收纳和排列网站架构。
2015-08-06 16:49:54 +08:00
2017-06-30 21:10:47 +08:00
更多布局和导航的使用可以参考:[通用布局](/components/layout)。
2021-06-30 18:04:15 +08:00
## 开发者注意事项
2021-06-22 11:22:20 +08:00
- Menu 元素为 `ul` ,因而仅支持 [`li` 以及 `script-supporting` 子元素 ](https://html.spec.whatwg.org/multipage/grouping-content.html#the-ul-element )。因而你的子节点元素应该都在 `Menu.Item` 内使用。
- Menu 需要计算节点结构,因而其子元素仅支持 `Menu.*` 以及对此进行封装的 HOC 组件。
2017-06-30 21:10:47 +08:00
## API
2015-11-17 16:33:47 +08:00
2019-12-26 14:37:39 +08:00
```jsx
2022-03-18 15:20:35 +08:00
const items = [
{ label: '菜单项' },
{
label: '子菜单',
children: [{ label: '子菜单项' }],
},
];
< Menu items = {items} / > ;
2015-08-06 16:49:54 +08:00
```
2017-06-16 16:56:03 +08:00
### Menu
2015-08-06 16:49:54 +08:00
2019-07-11 14:14:33 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
2020-06-30 13:26:37 +08:00
| defaultOpenKeys | 初始展开的 SubMenu 菜单项 key 数组 | string\[] | - | |
| defaultSelectedKeys | 初始选中的菜单项 key 数组 | string\[] | - | |
2020-11-06 15:25:43 +08:00
| expandIcon | 自定义展开图标 | ReactNode \| `(props: SubMenuProps & { isSubMenu: boolean }) => ReactNode` | - | 4.9.0 |
2019-07-11 14:14:33 +08:00
| forceSubMenuRender | 在子菜单展示之前就渲染进 DOM | boolean | false | |
| inlineCollapsed | inline 时菜单是否收起状态 | boolean | - | |
| inlineIndent | inline 模式的菜单缩进宽度 | number | 24 | |
2022-03-18 15:20:35 +08:00
| items | 菜单内容 | [ItemType\[\]](#ItemType) | - | 4.20.0 |
2020-01-17 17:23:48 +08:00
| mode | 菜单类型,现在支持垂直、水平、和内嵌模式三种 | `vertical` \| `horizontal` \| `inline` | `vertical` | |
2019-07-11 14:14:33 +08:00
| multiple | 是否允许多选 | boolean | false | |
2020-06-30 13:26:37 +08:00
| openKeys | 当前展开的 SubMenu 菜单项 key 数组 | string\[] | - | |
2022-02-12 22:01:24 +08:00
| overflowedIndicator | 用于自定义 Menu 水平空间不足时的省略收缩的图标 | ReactNode | `<EllipsisOutlined />` | |
2019-07-11 14:14:33 +08:00
| selectable | 是否允许选中 | boolean | true | |
2020-06-30 13:26:37 +08:00
| selectedKeys | 当前选中的菜单项 key 数组 | string\[] | - | |
| style | 根节点样式 | CSSProperties | - | |
2019-07-11 14:14:33 +08:00
| subMenuCloseDelay | 用户鼠标离开子菜单后关闭延时,单位:秒 | number | 0.1 | |
| subMenuOpenDelay | 用户鼠标进入子菜单后开启延时,单位:秒 | number | 0 | |
2020-01-17 17:23:48 +08:00
| theme | 主题颜色 | `light` \| `dark` | `light` | |
2020-06-28 22:41:59 +08:00
| triggerSubMenuAction | SubMenu 展开/关闭的触发行为 | `hover` \| `click` | `hover` | |
2020-10-21 10:33:43 +08:00
| onClick | 点击 MenuItem 调用此函数 | function({ item, key, keyPath, domEvent }) | - | |
| onDeselect | 取消选中时调用,仅在 multiple 生效 | function({ item, key, keyPath, selectedKeys, domEvent }) | - | |
| onOpenChange | SubMenu 展开/关闭的回调 | function(openKeys: string\[]) | - | |
| onSelect | 被选中时调用 | function({ item, key, keyPath, selectedKeys, domEvent }) | - | |
2016-05-08 16:05:07 +08:00
2020-10-12 12:00:00 +08:00
> 更多属性查看 [rc-menu](https://github.com/react-component/menu#api)
2015-08-06 16:49:54 +08:00
2022-03-18 15:20:35 +08:00
### ItemType
2015-08-06 16:49:54 +08:00
2022-03-18 15:20:35 +08:00
> type ItemType = [MenuItemType](#MenuItemType) | [SubMenuType](#SubMenuType) | [MenuItemGroupType](#MenuItemGroupType) | [MenuDividerType](#MenuDividerType);
#### MenuItemType
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| -------- | ------------------------ | --------- | ------ | ---- |
| danger | 展示错误状态样式 | boolean | false | |
| disabled | 是否禁用 | boolean | false | |
| icon | 菜单图标 | ReactNode | - | |
| key | item 的唯一标志 | string | - | |
2022-04-19 21:02:06 +08:00
| label | 菜单项标题 | ReactNode | - | |
2022-03-18 15:20:35 +08:00
| title | 设置收缩时展示的悬浮标题 | string | - | |
2020-04-26 23:16:15 +08:00
> 注意:`icon` 是 `4.2.0` 新增的属性,之前的版本请使用下面的方式定义图标。
>
> ```jsx
> <Menu.Item>
> <PieChartOutlined />
> <span>Option 1</span>
> </Menu.Item>
> <Menu.SubMenu
> title={
> <>
> <PieChartOutlined />
> <span>Option 2</span>
> </>
> }
> >
> ...
> </Menu.SubMenu>
> ```
2015-08-06 16:49:54 +08:00
2022-03-18 15:20:35 +08:00
#### SubMenuType
2015-08-06 16:49:54 +08:00
2020-10-21 10:33:43 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
2022-02-14 15:21:33 +08:00
| --- | --- | --- | --- | --- | --- |
2022-03-18 15:20:35 +08:00
| children | 子菜单的菜单项 | [ItemType\[\]](#ItemType) | - | |
2020-10-21 10:33:43 +08:00
| disabled | 是否禁用 | boolean | false | |
2022-03-18 15:20:35 +08:00
| icon | 菜单图标 | ReactNode | - | |
2020-10-21 10:33:43 +08:00
| key | 唯一标志 | string | - | |
2022-03-18 15:20:35 +08:00
| label | 菜单项标题 | ReactNode | - | |
2020-11-17 10:59:04 +08:00
| popupClassName | 子菜单样式,`mode="inline"` 时无效 | string | - | |
| popupOffset | 子菜单偏移量,`mode="inline"` 时无效 | \[number, number] | - | |
2020-10-21 10:33:43 +08:00
| onTitleClick | 点击子菜单标题 | function({ key, domEvent }) | - | |
2022-03-18 15:20:35 +08:00
| theme | 设置子菜单的主题,默认从 Menu 上继承 | | `light` \| `dark` | - | |
2015-12-11 16:55:30 +08:00
2022-03-18 15:20:35 +08:00
#### MenuItemGroupType
2015-12-11 16:55:30 +08:00
2022-03-18 15:20:35 +08:00
定义类型为 `group` 时,会作为分组处理:
```ts
const groupItem = {
type: 'group', // Must have
label: 'My Group',
chidlren: [],
};
```
2016-11-15 14:12:25 +08:00
2022-03-18 15:20:35 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| -------- | ------------ | --------------------------------- | ------ | ---- |
| children | 分组的菜单项 | [MenuItemType\[\]](#MenuItemType) | - | |
| label | 分组标题 | ReactNode | - | |
2016-11-15 14:12:25 +08:00
2022-03-18 15:20:35 +08:00
#### MenuDividerType
菜单项分割线,只用在弹出菜单内,需要定义类型为 `divider` :
```ts
const dividerItem = {
type: 'divider', // Must have
};
```
2021-06-22 11:22:20 +08:00
2022-03-18 15:20:35 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| ------ | -------- | ------- | ------ | ---- |
| dashed | 是否虚线 | boolean | false | |
2021-07-19 15:42:07 +08:00
2021-06-22 11:22:20 +08:00
## FAQ
### 为何 Menu 的子元素会渲染两次?
Menu 通过[二次渲染](https://github.com/react-component/menu/blob/f4684514096d6b7123339cbe72e7b0f68db0bce2/src/Menu.tsx#L543)收集嵌套结构信息以支持 HOC 的结构。合并成一个推导结构会使得逻辑变得十分复杂,欢迎 PR 以协助改进该设计。