• Dropdown 下拉菜单

    向下弹出的列表。

    何时使用

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

    代码演示

    最简单的下拉菜单。
    expand code expand code
    import { Menu, Dropdown, Icon } from 'choerodon-ui';
    
    const menu = (
      <Menu>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">1st menu item</a>
        </Menu.Item>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">2nd menu item</a>
        </Menu.Item>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">3rd menu item</a>
        </Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <div>
        <Dropdown overlay={menu}>
          <a className="ant-dropdown-link" href="#">
            Hover me <Icon type="arrow_drop_down" />
          </a>
        </Dropdown>
      </div>,
      mountNode);
    
    分割线和不可用菜单项。
    expand code expand code
    import { Menu, Dropdown, Icon } from 'choerodon-ui';
    
    const menu = (
      <Menu>
        <Menu.Item key="0">
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">1st menu item</a>
        </Menu.Item>
        <Menu.Item key="1">
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">2nd menu item</a>
        </Menu.Item>
        <Menu.Divider />
        <Menu.Item key="3" disabled>3rd menu item(disabled)</Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <Dropdown overlay={menu}>
        <a className="ant-dropdown-link" href="#">
          Hover me <Icon type="arrow_drop_down" />
        </a>
      </Dropdown>,
      mountNode);
    
    点击菜单项后会触发事件,用户可以通过相应的菜单项 key 进行不同的操作。
    expand code expand code
    import { Menu, Dropdown, Icon, message } from 'choerodon-ui';
    const onClick = function ({ key }) {
      message.info(`Click on item ${key}`);
    };
    
    const menu = (
      <Menu onClick={onClick}>
        <Menu.Item key="1">1st menu item</Menu.Item>
        <Menu.Item key="2">2nd memu item</Menu.Item>
        <Menu.Item key="3">3rd menu item</Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <Dropdown overlay={menu}>
        <a className="ant-dropdown-link" href="#">
          Hover me, Click menu item <Icon type="arrow_drop_down" />
        </a>
      </Dropdown>,
      mountNode);
    
    传入的菜单里有多个层级。
    expand code expand code
    import { Menu, Dropdown, Icon } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    
    const menu = (
      <Menu>
        <Menu.Item>1st menu item</Menu.Item>
        <Menu.Item>2nd menu item</Menu.Item>
        <SubMenu title="sub menu">
          <Menu.Item>3rd menu item</Menu.Item>
          <Menu.Item>4th menu item</Menu.Item>
        </SubMenu>
        <SubMenu title="disabled sub menu" disabled>
          <Menu.Item>5d menu item</Menu.Item>
          <Menu.Item>6th menu item</Menu.Item>
        </SubMenu>
      </Menu>
    );
    
    ReactDOM.render(
      <Dropdown overlay={menu}>
        <a className="ant-dropdown-link" href="#">
          Cascading menu <Icon type="arrow_drop_down" />
        </a>
      </Dropdown>,
      mountNode);
    
    默认是移入触发菜单,可以点击触发。
    expand code expand code
    import { Menu, Dropdown } from 'choerodon-ui';
    
    const menu = (
      <Menu>
        <Menu.Item key="1">1st menu item</Menu.Item>
        <Menu.Item key="2">2nd menu item</Menu.Item>
        <Menu.Item key="3">3rd menu item</Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <Dropdown overlay={menu} trigger={['contextMenu']}>
        <span style={{ userSelect: 'none' }}>Right Click on Me</span>
      </Dropdown>,
      mountNode);
    
    支持 6 个弹出位置。
    expand code expand code
    import { Menu, Dropdown, Button } from 'choerodon-ui';
    
    const menu = (
      <Menu>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">1st menu item</a>
        </Menu.Item>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">2nd menu item</a>
        </Menu.Item>
        <Menu.Item>
          <a target="_blank" rel="noopener noreferrer" href="https://github.com/choerodon">3rd menu item</a>
        </Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <div>
        <Dropdown overlay={menu} placement="bottomLeft">
          <Button>bottomLeft</Button>
        </Dropdown>
        <Dropdown overlay={menu} placement="bottomCenter">
          <Button>bottomCenter</Button>
        </Dropdown>
        <Dropdown overlay={menu} placement="bottomRight">
          <Button>bottomRight</Button>
        </Dropdown>
        <br />
        <Dropdown overlay={menu} placement="topLeft">
          <Button>topLeft</Button>
        </Dropdown>
        <Dropdown overlay={menu} placement="topCenter">
          <Button>topCenter</Button>
        </Dropdown>
        <Dropdown overlay={menu} placement="topRight">
          <Button>topRight</Button>
        </Dropdown>
      </div>,
      mountNode);
    
    默认是移入触发菜单,可以点击触发。
    expand code expand code
    import { Menu, Dropdown, Icon, Button } from 'choerodon-ui';
    
    const menu = (
      <Menu>
        <Menu.Item key="0">
          <a href="https://github.com/choerodon">1st menu item</a>
        </Menu.Item>
        <Menu.Item key="1">
          <a href="https://github.com/choerodon">2nd menu item</a>
        </Menu.Item>
        <Menu.Divider />
        <Menu.Item key="3">3rd menu item</Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <div>
        <Dropdown overlay={menu} trigger={['click']}>
          <a className="ant-dropdown-link" href="#">
            Click me <Icon type="arrow_drop_down" />
          </a>
        </Dropdown>
        <Dropdown overlay={menu} trigger="click">
          <Button shape="circle" icon="more_vert" />
        </Dropdown>
      </div>,
      mountNode);
    
    左边是按钮,右边是额外的相关功能菜单。
    expand code expand code
    import { Menu, Dropdown, Button, Icon, message } from 'choerodon-ui';
    
    function handleButtonClick(e) {
      message.info('Click on left button.');
      console.log('click left button', e);
    }
    
    function handleMenuClick(e) {
      message.info('Click on menu item.');
      console.log('click', e);
    }
    
    const menu = (
      <Menu onClick={handleMenuClick}>
        <Menu.Item key="1">1st menu item</Menu.Item>
        <Menu.Item key="2">2nd menu item</Menu.Item>
        <Menu.Item key="3">3rd item</Menu.Item>
      </Menu>
    );
    
    ReactDOM.render(
      <div>
        <Dropdown.Button onClick={handleButtonClick} overlay={menu}>
          Dropdown
        </Dropdown.Button>
        <Dropdown.Button
          onClick={handleButtonClick}
          overlay={menu}
          disabled
          style={{ marginLeft: 8 }}
        >
          Dropdown
        </Dropdown.Button>
        <Dropdown overlay={menu}>
          <Button style={{ marginLeft: 8 }}>
            Button <Icon type="arrow_drop_down" />
          </Button>
        </Dropdown>
      </div>,
      mountNode);
    
    默认是点击关闭菜单,可以关闭此功能。
    expand code expand code
    import { Menu, Dropdown, Icon } from 'choerodon-ui';
    
    class OverlayVisible extends React.Component {
      state = {
        visible: false,
      };
    
      handleMenuClick = (e) => {
        if (e.key === '3') {
          this.setState({ visible: false });
        }
      }
    
      handleVisibleChange = (flag) => {
        this.setState({ visible: flag });
      }
    
      render() {
        const menu = (
          <Menu onClick={this.handleMenuClick}>
            <Menu.Item key="1">Clicking me will not close the menu.</Menu.Item>
            <Menu.Item key="2">Clicking me will not close the menu also.</Menu.Item>
            <Menu.Item key="3">Clicking me will close the menu</Menu.Item>
          </Menu>
        );
        return (
          <Dropdown overlay={menu}
            onVisibleChange={this.handleVisibleChange}
            visible={this.state.visible}
          >
            <a className="ant-dropdown-link" href="#">
              Hover me <Icon type="arrow_drop_down" />
            </a>
          </Dropdown>
        );
      }
    }
    
    ReactDOM.render(<OverlayVisible />, mountNode);
    

    API

    属性如下

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

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

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

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

    参数说明类型默认值
    disabled菜单是否禁用boolean-
    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-