2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
|
|
|
|
category: Components
|
2016-09-21 11:28:38 +08:00
|
|
|
|
subtitle: 下拉菜单
|
2018-11-04 16:20:35 +08:00
|
|
|
|
type: 导航
|
2016-09-21 11:28:38 +08:00
|
|
|
|
title: Dropdown
|
2020-06-05 13:50:09 +08:00
|
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/eedWN59yJ/Dropdown.svg
|
2016-03-31 14:17:09 +08:00
|
|
|
|
---
|
2015-06-08 19:10:47 +08:00
|
|
|
|
|
2015-06-14 17:54:08 +08:00
|
|
|
|
向下弹出的列表。
|
|
|
|
|
|
2015-06-08 19:10:47 +08:00
|
|
|
|
## 何时使用
|
|
|
|
|
|
2015-08-21 15:22:09 +08:00
|
|
|
|
当页面上的操作命令过多时,用此组件可以收纳操作元素。点击或移入触点,会出现一个下拉菜单。可在列表中进行选择,并执行相应的命令。
|
2015-06-08 19:10:47 +08:00
|
|
|
|
|
2020-06-03 16:28:06 +08:00
|
|
|
|
- 用于收罗一组命令操作。
|
|
|
|
|
- Select 用于选择,而 Dropdown 是命令集合。
|
|
|
|
|
|
2022-10-23 00:33:45 +08:00
|
|
|
|
### 4.24.0 用法升级
|
|
|
|
|
|
|
|
|
|
```__react
|
|
|
|
|
import Alert from '../alert';
|
|
|
|
|
ReactDOM.render(<Alert message="在 4.24.0 版本后,我们提供了 <Dropdown menu={{ items: [...] }} /> 的简写方式,有更好的性能和更方便的数据组织方式,开发者不再需要自行拼接 JSX。同时我们废弃了原先的写法,你还是可以在 4.x 继续使用,但会在控制台看到警告,并会在 5.0 后移除。" />, mountNode);
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
// >=4.24.0 可用,推荐的写法 ✅
|
|
|
|
|
const items = [
|
|
|
|
|
{ label: '菜单项一', key: 'item-1' }, // 菜单项务必填写 key
|
|
|
|
|
{ label: '菜单项二', key: 'item-2' },
|
|
|
|
|
];
|
|
|
|
|
return (
|
|
|
|
|
<Dropdown menu={{ items }}>
|
|
|
|
|
<a>Hover me</a>
|
|
|
|
|
</Dropdown>
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// <4.24.0 可用,>=4.24.0 时不推荐 🙅🏻♀️
|
|
|
|
|
const menu = (
|
|
|
|
|
<Menu>
|
|
|
|
|
<Menu.Item>菜单项一</Menu.Item>
|
|
|
|
|
<Menu.Item>菜单项二</Menu.Item>
|
|
|
|
|
</Menu>
|
|
|
|
|
);
|
|
|
|
|
return (
|
|
|
|
|
<Dropdown overlay={menu}>
|
|
|
|
|
<a>Hover me</a>
|
|
|
|
|
</Dropdown>
|
|
|
|
|
);
|
|
|
|
|
```
|
|
|
|
|
|
2015-06-08 19:10:47 +08:00
|
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
属性如下
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2022-01-13 13:34:34 +08:00
|
|
|
|
| arrow | 下拉框箭头是否显示 | boolean \| { pointAtCenter: boolean } | false | |
|
2022-12-23 10:40:11 +08:00
|
|
|
|
| autoAdjustOverflow | 下拉框被遮挡时自动调整位置 | boolean | true | >= 4.24.5 < 5.0.0 \|\| >= 5.2.0 |
|
2022-05-05 16:45:07 +08:00
|
|
|
|
| autoFocus | 打开后自动聚焦下拉框 | boolean | false | 4.21.0 |
|
2020-06-28 22:41:59 +08:00
|
|
|
|
| disabled | 菜单是否禁用 | boolean | - | |
|
2021-08-08 14:49:22 +08:00
|
|
|
|
| destroyPopupOnHide | 关闭后是否销毁 Dropdown | boolean | false | |
|
2022-10-23 00:33:45 +08:00
|
|
|
|
| dropdownRender | 自定义下拉框内容 | (menus: ReactNode) => ReactNode | - | 4.24.0 |
|
2020-10-19 11:14:04 +08:00
|
|
|
|
| getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。[示例](https://codepen.io/afc163/pen/zEjNOy?editors=0010) | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
|
2022-10-23 00:33:45 +08:00
|
|
|
|
| menu | 菜单配置项 | [MenuProps](/components/menu/#API) | - | 4.24.0 |
|
2020-01-06 11:13:39 +08:00
|
|
|
|
| overlayClassName | 下拉根元素的类名称 | string | - | |
|
2020-10-19 01:06:01 +08:00
|
|
|
|
| overlayStyle | 下拉根元素的样式 | CSSProperties | - | |
|
2022-01-13 13:34:34 +08:00
|
|
|
|
| placement | 菜单弹出位置:`bottom` `bottomLeft` `bottomRight` `top` `topLeft` `topRight` | string | `bottomLeft` | |
|
2020-06-30 11:25:55 +08:00
|
|
|
|
| trigger | 触发下拉的行为, 移动端不支持 hover | Array<`click`\|`hover`\|`contextMenu`> | \[`hover`] | |
|
2022-09-06 14:03:39 +08:00
|
|
|
|
| open | 菜单是否显示,小于 4.23.0 使用 `visible`([为什么?](/docs/react/faq#why-open)) | boolean | - | 4.23.0 |
|
|
|
|
|
| onOpenChange | 菜单显示状态改变时调用,点击菜单按钮导致的消失不会触发。小于 4.23.0 使用 `onVisibleChange`([为什么?](/docs/react/faq#why-open)) | (open: boolean) => void | - | 4.23.0 |
|
2015-06-08 19:10:47 +08:00
|
|
|
|
|
2016-09-15 01:21:48 +08:00
|
|
|
|
### Dropdown.Button
|
2015-12-02 15:18:15 +08:00
|
|
|
|
|
2022-10-23 00:33:45 +08:00
|
|
|
|
属性与 Dropdown 的相同。还包含以下属性:
|
|
|
|
|
|
2019-05-06 12:04:39 +08:00
|
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
2019-05-07 14:57:32 +08:00
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| buttonsRender | 自定义左右两个按钮 | (buttons: ReactNode\[]) => ReactNode\[] | - | |
|
2021-10-21 21:07:55 +08:00
|
|
|
|
| loading | 设置按钮载入状态 | boolean \| { delay: number } | false | |
|
2022-08-04 10:49:55 +08:00
|
|
|
|
| danger | 设置危险按钮 | boolean | - | 4.23.0 |
|
2019-11-20 18:10:44 +08:00
|
|
|
|
| icon | 右侧的 icon | ReactNode | - | |
|
2020-10-19 11:14:04 +08:00
|
|
|
|
| size | 按钮大小,和 [Button](/components/button/#API) 一致 | string | `default` | |
|
|
|
|
|
| type | 按钮类型,和 [Button](/components/button/#API) 一致 | string | `default` | |
|
2020-10-21 10:33:43 +08:00
|
|
|
|
| onClick | 点击左侧按钮的回调,和 [Button](/components/button/#API) 一致 | (event) => void | - | |
|