mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-15 09:21:22 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
192 lines
8.2 KiB
Markdown
192 lines
8.2 KiB
Markdown
---
|
||
category: Components
|
||
group: 导航
|
||
title: Menu
|
||
subtitle: 导航菜单
|
||
cover: https://gw.alipayobjects.com/zos/alicdn/3XZcjGpvK/Menu.svg
|
||
---
|
||
|
||
为页面和功能提供导航的菜单列表。
|
||
|
||
## 何时使用
|
||
|
||
导航菜单是一个网站的灵魂，用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航，顶部导航提供全局性的类目和功能，侧边导航提供多级结构来收纳和排列网站架构。
|
||
|
||
更多布局和导航的使用可以参考：[通用布局](/components/layout-cn)。
|
||
|
||
## 开发者注意事项
|
||
|
||
- Menu 元素为 `ul`，因而仅支持 [`li` 以及 `script-supporting` 子元素](https://html.spec.whatwg.org/multipage/grouping-content.html#the-ul-element)。因而你的子节点元素应该都在 `Menu.Item` 内使用。
|
||
- Menu 需要计算节点结构，因而其子元素仅支持 `Menu.*` 以及对此进行封装的 HOC 组件。
|
||
|
||
### 4.20.0 用法升级
|
||
|
||
<Alert message="在 4.20.0 版本后，我们提供了 <Menu items={[...]} /> 的简写方式，有更好的性能和更方便的数据组织方式，开发者不再需要自行拼接 JSX。同时我们废弃了原先的写法，你还是可以在 4.x 继续使用，但会在控制台看到警告，并会在 5.0 后移除。"></Alert>
|
||
|
||
```jsx
|
||
// >=4.20.0 可用，推荐的写法 ✅
|
||
const items = [
|
||
{ label: '菜单项一', key: 'item-1' }, // 菜单项务必填写 key
|
||
{ label: '菜单项二', key: 'item-2' },
|
||
{
|
||
label: '子菜单',
|
||
key: 'submenu',
|
||
children: [{ label: '子菜单项', key: 'submenu-item-1' }],
|
||
},
|
||
];
|
||
return <Menu items={items} />;
|
||
|
||
// <4.20.0 可用，>=4.20.0 时不推荐 🙅🏻♀️
|
||
<Menu>
|
||
<Menu.Item>菜单项一</Menu.Item>
|
||
<Menu.Item>菜单项二</Menu.Item>
|
||
<Menu.SubMenu title="子菜单">
|
||
<Menu.Item>子菜单项</Menu.Item>
|
||
</Menu.SubMenu>
|
||
</Menu>;
|
||
```
|
||
|
||
`<4.20.0` 版本的 JSX 演示写法可以参考 [https://github.com/ant-design/ant-design/tree/4.19.5/components/menu/demo](https://github.com/ant-design/ant-design/tree/4.19.5/components/menu/demo)。
|
||
|
||
## 代码演示
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/deprecated.tsx">基础用法（废弃的语法糖）</code>
|
||
<code src="./demo/horizontal.tsx">顶部导航</code>
|
||
<code src="./demo/inline.tsx">内嵌菜单</code>
|
||
<code src="./demo/inline-collapsed.tsx">缩起内嵌菜单</code>
|
||
<code src="./demo/sider-current.tsx">只展开当前父级菜单</code>
|
||
<code src="./demo/vertical.tsx">垂直菜单</code>
|
||
<code src="./demo/theme.tsx">主题</code>
|
||
<code src="./demo/submenu-theme.tsx">子菜单主题</code>
|
||
<code src="./demo/switch-mode.tsx">切换菜单类型</code>
|
||
<code src="./demo/style-debug.tsx" debug>Style debug</code>
|
||
<code src="./demo/menu-v4.tsx" debug>v4 版本 Menu</code>
|
||
|
||
## API
|
||
|
||
### Menu
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| defaultOpenKeys | 初始展开的 SubMenu 菜单项 key 数组 | string\[] | - | |
|
||
| defaultSelectedKeys | 初始选中的菜单项 key 数组 | string\[] | - | |
|
||
| expandIcon | 自定义展开图标 | ReactNode \| `(props: SubMenuProps & { isSubMenu: boolean }) => ReactNode` | - | 4.9.0 |
|
||
| forceSubMenuRender | 在子菜单展示之前就渲染进 DOM | boolean | false | |
|
||
| inlineCollapsed | inline 时菜单是否收起状态 | boolean | - | |
|
||
| inlineIndent | inline 模式的菜单缩进宽度 | number | 24 | |
|
||
| items | 菜单内容 | [ItemType\[\]](#ItemType) | - | 4.20.0 |
|
||
| mode | 菜单类型，现在支持垂直、水平、和内嵌模式三种 | `vertical` \| `horizontal` \| `inline` | `vertical` | |
|
||
| multiple | 是否允许多选 | boolean | false | |
|
||
| openKeys | 当前展开的 SubMenu 菜单项 key 数组 | string\[] | - | |
|
||
| overflowedIndicator | 用于自定义 Menu 水平空间不足时的省略收缩的图标 | ReactNode | `<EllipsisOutlined />` | |
|
||
| selectable | 是否允许选中 | boolean | true | |
|
||
| selectedKeys | 当前选中的菜单项 key 数组 | string\[] | - | |
|
||
| style | 根节点样式 | CSSProperties | - | |
|
||
| subMenuCloseDelay | 用户鼠标离开子菜单后关闭延时，单位：秒 | number | 0.1 | |
|
||
| subMenuOpenDelay | 用户鼠标进入子菜单后开启延时，单位：秒 | number | 0 | |
|
||
| theme | 主题颜色 | `light` \| `dark` | `light` | |
|
||
| triggerSubMenuAction | SubMenu 展开/关闭的触发行为 | `hover` \| `click` | `hover` | |
|
||
| 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 }) | - | |
|
||
|
||
> 更多属性查看 [rc-menu](https://github.com/react-component/menu#api)
|
||
|
||
### ItemType
|
||
|
||
> type ItemType = [MenuItemType](#MenuItemType) | [SubMenuType](#SubMenuType) | [MenuItemGroupType](#MenuItemGroupType) | [MenuDividerType](#MenuDividerType);
|
||
|
||
#### MenuItemType
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| -------- | ------------------------ | --------- | ------ | ---- |
|
||
| danger | 展示错误状态样式 | boolean | false | |
|
||
| disabled | 是否禁用 | boolean | false | |
|
||
| icon | 菜单图标 | ReactNode | - | |
|
||
| key | item 的唯一标志 | string | - | |
|
||
| label | 菜单项标题 | ReactNode | - | |
|
||
| title | 设置收缩时展示的悬浮标题 | string | - | |
|
||
|
||
> 注意：`icon` 是 `4.2.0` 新增的属性，之前的版本请使用下面的方式定义图标。
|
||
>
|
||
> ```jsx
|
||
> <Menu.Item>
|
||
> <PieChartOutlined />
|
||
> <span>Option 1</span>
|
||
> </Menu.Item>
|
||
> <Menu.SubMenu
|
||
> title={
|
||
> <>
|
||
> <PieChartOutlined />
|
||
> <span>Option 2</span>
|
||
> </>
|
||
> }
|
||
> >
|
||
> ...
|
||
> </Menu.SubMenu>
|
||
> ```
|
||
|
||
#### SubMenuType
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| children | 子菜单的菜单项 | [ItemType\[\]](#ItemType) | - | |
|
||
| disabled | 是否禁用 | boolean | false | |
|
||
| icon | 菜单图标 | ReactNode | - | |
|
||
| key | 唯一标志 | string | - | |
|
||
| label | 菜单项标题 | ReactNode | - | |
|
||
| popupClassName | 子菜单样式，`mode="inline"` 时无效 | string | - | |
|
||
| popupOffset | 子菜单偏移量，`mode="inline"` 时无效 | \[number, number] | - | |
|
||
| onTitleClick | 点击子菜单标题 | function({ key, domEvent }) | - | |
|
||
| theme | 设置子菜单的主题，默认从 Menu 上继承 | `light` \| `dark` | - | |
|
||
|
||
#### MenuItemGroupType
|
||
|
||
定义类型为 `group` 时，会作为分组处理:
|
||
|
||
```ts
|
||
const groupItem = {
|
||
type: 'group', // Must have
|
||
label: 'My Group',
|
||
children: [],
|
||
};
|
||
```
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| -------- | ------------ | --------------------------------- | ------ | ---- |
|
||
| children | 分组的菜单项 | [MenuItemType\[\]](#MenuItemType) | - | |
|
||
| label | 分组标题 | ReactNode | - | |
|
||
|
||
#### MenuDividerType
|
||
|
||
菜单项分割线，只用在弹出菜单内，需要定义类型为 `divider`：
|
||
|
||
```ts
|
||
const dividerItem = {
|
||
type: 'divider', // Must have
|
||
};
|
||
```
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| ------ | -------- | ------- | ------ | ---- |
|
||
| dashed | 是否虚线 | boolean | false | |
|
||
|
||
## FAQ
|
||
|
||
### 为何 Menu 的子元素会渲染两次？
|
||
|
||
Menu 通过[二次渲染](https://github.com/react-component/menu/blob/f4684514096d6b7123339cbe72e7b0f68db0bce2/src/Menu.tsx#L543)收集嵌套结构信息以支持 HOC 的结构。合并成一个推导结构会使得逻辑变得十分复杂，欢迎 PR 以协助改进该设计。
|
||
|
||
### 在 Flex 布局中，Menu 没有按照预期响应式省略菜单？
|
||
|
||
Menu 初始化时会先全部渲染，然后根据宽度裁剪内容。当处于 Flex 布局中，你需要告知其预期宽度为响应式宽度（[在线 Demo](https://codesandbox.io/s/ding-bu-dao-hang-antd-4-21-7-forked-5e3imy?file=/demo.js)）：
|
||
|
||
```jsx
|
||
<div style={{ flex }}>
|
||
<div style={{ ... }}>Some Content</div>
|
||
<Menu style={{ minWidth: 0, flex: "auto" }} />
|
||
</div>
|
||
```
|