Dropdown下拉菜单

向下弹出的列表。

何时使用

当页面上的操作命令过多时,用此组件可以收纳操作元素。点击或移入触点,会出现一个下拉菜单。可在列表中进行选择,并执行相应的命令。

代码演示

Dropdown下拉菜单 - 图1

基本

最简单的下拉菜单。

  1. import { Menu, Dropdown } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. const menu = (
  4. <Menu>
  5. <Menu.Item>
  6. <a target="_blank" rel="noopener noreferrer" href="http://www.alipay.com/">
  7. 1st menu item
  8. </a>
  9. </Menu.Item>
  10. <Menu.Item>
  11. <a target="_blank" rel="noopener noreferrer" href="http://www.taobao.com/">
  12. 2nd menu item
  13. </a>
  14. </Menu.Item>
  15. <Menu.Item>
  16. <a target="_blank" rel="noopener noreferrer" href="http://www.tmall.com/">
  17. 3rd menu item
  18. </a>
  19. </Menu.Item>
  20. </Menu>
  21. );
  22. ReactDOM.render(
  23. <Dropdown overlay={menu}>
  24. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  25. Hover me <DownOutlined />
  26. </a>
  27. </Dropdown>,
  28. mountNode,
  29. );

Dropdown下拉菜单 - 图2

其他元素

分割线和不可用菜单项。

  1. import { Menu, Dropdown } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. const menu = (
  4. <Menu>
  5. <Menu.Item key="0">
  6. <a target="_blank" rel="noopener noreferrer" href="http://www.alipay.com/">
  7. 1st menu item
  8. </a>
  9. </Menu.Item>
  10. <Menu.Item key="1">
  11. <a target="_blank" rel="noopener noreferrer" href="http://www.taobao.com/">
  12. 2nd menu item
  13. </a>
  14. </Menu.Item>
  15. <Menu.Divider />
  16. <Menu.Item key="3" disabled>
  17. 3rd menu itemdisabled
  18. </Menu.Item>
  19. </Menu>
  20. );
  21. ReactDOM.render(
  22. <Dropdown overlay={menu}>
  23. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  24. Hover me <DownOutlined />
  25. </a>
  26. </Dropdown>,
  27. mountNode,
  28. );

Dropdown下拉菜单 - 图3

触发事件

点击菜单项后会触发事件,用户可以通过相应的菜单项 key 进行不同的操作。

  1. import { Menu, Dropdown, message } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. const onClick = ({ key }) => {
  4. message.info(`Click on item ${key}`);
  5. };
  6. const menu = (
  7. <Menu onClick={onClick}>
  8. <Menu.Item key="1">1st menu item</Menu.Item>
  9. <Menu.Item key="2">2nd memu item</Menu.Item>
  10. <Menu.Item key="3">3rd menu item</Menu.Item>
  11. </Menu>
  12. );
  13. ReactDOM.render(
  14. <Dropdown overlay={menu}>
  15. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  16. Hover me, Click menu item <DownOutlined />
  17. </a>
  18. </Dropdown>,
  19. mountNode,
  20. );

Dropdown下拉菜单 - 图4

多级菜单

传入的菜单里有多个层级。

  1. import { Menu, Dropdown } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. const { SubMenu } = Menu;
  4. const menu = (
  5. <Menu>
  6. <Menu.Item>1st menu item</Menu.Item>
  7. <Menu.Item>2nd menu item</Menu.Item>
  8. <SubMenu title="sub menu">
  9. <Menu.Item>3rd menu item</Menu.Item>
  10. <Menu.Item>4th menu item</Menu.Item>
  11. </SubMenu>
  12. <SubMenu title="disabled sub menu" disabled>
  13. <Menu.Item>5d menu item</Menu.Item>
  14. <Menu.Item>6th menu item</Menu.Item>
  15. </SubMenu>
  16. </Menu>
  17. );
  18. ReactDOM.render(
  19. <Dropdown overlay={menu}>
  20. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  21. Cascading menu <DownOutlined />
  22. </a>
  23. </Dropdown>,
  24. mountNode,
  25. );

Dropdown下拉菜单 - 图5

右键菜单

默认是移入触发菜单,可以点击鼠标右键触发。

  1. import { Menu, Dropdown } from 'antd';
  2. const menu = (
  3. <Menu>
  4. <Menu.Item key="1">1st menu item</Menu.Item>
  5. <Menu.Item key="2">2nd menu item</Menu.Item>
  6. <Menu.Item key="3">3rd menu item</Menu.Item>
  7. </Menu>
  8. );
  9. ReactDOM.render(
  10. <Dropdown overlay={menu} trigger={['contextMenu']}>
  11. <div
  12. className="site-dropdown-context-menu"
  13. style={{
  14. textAlign: 'center',
  15. height: 200,
  16. lineHeight: '200px',
  17. }}
  18. >
  19. Right Click on here
  20. </div>
  21. </Dropdown>,
  22. mountNode,
  23. );
  1. .site-dropdown-context-menu {
  2. background: #f7f7f7;
  3. color: #777;
  4. }

Dropdown下拉菜单 - 图6

弹出位置

支持 6 个弹出位置。

  1. import { Menu, Dropdown, Button } from 'antd';
  2. const menu = (
  3. <Menu>
  4. <Menu.Item>
  5. <a target="_blank" rel="noopener noreferrer" href="http://www.alipay.com/">
  6. 1st menu item
  7. </a>
  8. </Menu.Item>
  9. <Menu.Item>
  10. <a target="_blank" rel="noopener noreferrer" href="http://www.taobao.com/">
  11. 2nd menu item
  12. </a>
  13. </Menu.Item>
  14. <Menu.Item>
  15. <a target="_blank" rel="noopener noreferrer" href="http://www.tmall.com/">
  16. 3rd menu item
  17. </a>
  18. </Menu.Item>
  19. </Menu>
  20. );
  21. ReactDOM.render(
  22. <div>
  23. <Dropdown overlay={menu} placement="bottomLeft">
  24. <Button>bottomLeft</Button>
  25. </Dropdown>
  26. <Dropdown overlay={menu} placement="bottomCenter">
  27. <Button>bottomCenter</Button>
  28. </Dropdown>
  29. <Dropdown overlay={menu} placement="bottomRight">
  30. <Button>bottomRight</Button>
  31. </Dropdown>
  32. <br />
  33. <Dropdown overlay={menu} placement="topLeft">
  34. <Button>topLeft</Button>
  35. </Dropdown>
  36. <Dropdown overlay={menu} placement="topCenter">
  37. <Button>topCenter</Button>
  38. </Dropdown>
  39. <Dropdown overlay={menu} placement="topRight">
  40. <Button>topRight</Button>
  41. </Dropdown>
  42. </div>,
  43. mountNode,
  44. );
  1. #components-dropdown-demo-placement .ant-btn {
  2. margin-right: 8px;
  3. margin-bottom: 8px;
  4. }

Dropdown下拉菜单 - 图7

触发方式

默认是移入触发菜单,可以点击触发。

  1. import { Menu, Dropdown } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. const menu = (
  4. <Menu>
  5. <Menu.Item key="0">
  6. <a href="http://www.alipay.com/">1st menu item</a>
  7. </Menu.Item>
  8. <Menu.Item key="1">
  9. <a href="http://www.taobao.com/">2nd menu item</a>
  10. </Menu.Item>
  11. <Menu.Divider />
  12. <Menu.Item key="3">3rd menu item</Menu.Item>
  13. </Menu>
  14. );
  15. ReactDOM.render(
  16. <Dropdown overlay={menu} trigger={['click']}>
  17. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  18. Click me <DownOutlined />
  19. </a>
  20. </Dropdown>,
  21. mountNode,
  22. );

Dropdown下拉菜单 - 图8

带下拉框的按钮

左边是按钮,右边是额外的相关功能菜单。可设置 icon 属性来修改右边的图标。

  1. import { Menu, Dropdown, Button, message, Tooltip } from 'antd';
  2. import { DownOutlined, UserOutlined } from '@ant-design/icons';
  3. function handleButtonClick(e) {
  4. message.info('Click on left button.');
  5. console.log('click left button', e);
  6. }
  7. function handleMenuClick(e) {
  8. message.info('Click on menu item.');
  9. console.log('click', e);
  10. }
  11. const menu = (
  12. <Menu onClick={handleMenuClick}>
  13. <Menu.Item key="1">
  14. <UserOutlined />
  15. 1st menu item
  16. </Menu.Item>
  17. <Menu.Item key="2">
  18. <UserOutlined />
  19. 2nd menu item
  20. </Menu.Item>
  21. <Menu.Item key="3">
  22. <UserOutlined />
  23. 3rd item
  24. </Menu.Item>
  25. </Menu>
  26. );
  27. ReactDOM.render(
  28. <div id="components-dropdown-demo-dropdown-button">
  29. <Dropdown.Button onClick={handleButtonClick} overlay={menu}>
  30. Dropdown
  31. </Dropdown.Button>
  32. <Dropdown.Button overlay={menu} icon={<UserOutlined />}>
  33. Dropdown
  34. </Dropdown.Button>
  35. <Dropdown.Button onClick={handleButtonClick} overlay={menu} disabled>
  36. Dropdown
  37. </Dropdown.Button>
  38. <Dropdown.Button
  39. overlay={menu}
  40. buttonsRender={([leftButton, rightButton]) => [
  41. <Tooltip title="tooltip" key="leftButton">
  42. {leftButton}
  43. </Tooltip>,
  44. rightButton,
  45. ]}
  46. >
  47. With Tooltip
  48. </Dropdown.Button>
  49. <Dropdown overlay={menu}>
  50. <Button>
  51. Button <DownOutlined />
  52. </Button>
  53. </Dropdown>
  54. </div>,
  55. mountNode,
  56. );
  1. #components-dropdown-demo-dropdown-button .ant-dropdown-button {
  2. margin: 0 8px 8px 0;
  3. }

Dropdown下拉菜单 - 图9

菜单隐藏方式

默认是点击关闭菜单,可以关闭此功能。

  1. import { Menu, Dropdown } from 'antd';
  2. import { DownOutlined } from '@ant-design/icons';
  3. class OverlayVisible extends React.Component {
  4. state = {
  5. visible: false,
  6. };
  7. handleMenuClick = e => {
  8. if (e.key === '3') {
  9. this.setState({ visible: false });
  10. }
  11. };
  12. handleVisibleChange = flag => {
  13. this.setState({ visible: flag });
  14. };
  15. render() {
  16. const menu = (
  17. <Menu onClick={this.handleMenuClick}>
  18. <Menu.Item key="1">Clicking me will not close the menu.</Menu.Item>
  19. <Menu.Item key="2">Clicking me will not close the menu also.</Menu.Item>
  20. <Menu.Item key="3">Clicking me will close the menu</Menu.Item>
  21. </Menu>
  22. );
  23. return (
  24. <Dropdown
  25. overlay={menu}
  26. onVisibleChange={this.handleVisibleChange}
  27. visible={this.state.visible}
  28. >
  29. <a className="ant-dropdown-link" onClick={e => e.preventDefault()}>
  30. Hover me <DownOutlined />
  31. </a>
  32. </Dropdown>
  33. );
  34. }
  35. }
  36. ReactDOM.render(<OverlayVisible />, mountNode);

API

属性如下

参数说明类型默认值版本
disabled菜单是否禁用boolean-
getPopupContainer菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。示例Function(triggerNode)() => document.body
overlay菜单Menu | () => Menu-
overlayClassName下拉根元素的类名称string-
overlayStyle下拉根元素的样式object-
placement菜单弹出位置:bottomLeft bottomCenter bottomRight topLeft topCenter topRightStringbottomLeft
trigger触发下拉的行为, 移动端不支持 hoverArray<click|hover|contextMenu>['hover']
visible菜单是否显示boolean-
onVisibleChange菜单显示状态改变时调用,参数为 visibleFunction(visible)-

overlay 菜单使用 Menu,还包括菜单项 Menu.Item,分割线 Menu.Divider

注意: Menu.Item 必须设置唯一的 key 属性。

Dropdown 下的 Menu 默认不可选中。如果需要菜单可选中,可以指定 <Menu selectable>.

Dropdown.Button

参数说明类型默认值版本
disabled菜单是否禁用boolean-
icon右侧的 iconReactNode-
overlay菜单Menu-
placement菜单弹出位置:bottomLeft bottomCenter bottomRight topLeft topCenter topRightStringbottomLeft
size按钮大小,和 Button 一致string'default'
trigger触发下拉的行为Array<click|hover|contextMenu>['hover']
type按钮类型,和 Button 一致string'default'
visible菜单是否显示boolean-
onClick点击左侧按钮的回调,和 Button 一致Function-
onVisibleChange菜单显示状态改变时调用,参数为 visibleFunction-
buttonsRender自定义左右两个按钮([buttons: ReactNode[]]) => ReactNode-