• Menu 导航菜单

    为页面和功能提供导航的菜单列表。

    何时使用

    导航菜单是一个网站的灵魂,用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航,顶部导航提供全局性的类目和功能,侧边导航提供多级结构来收纳和排列网站架构。

    更多布局和导航的使用可以参考:通用布局

    代码演示

    水平的顶部导航菜单。
    expand code expand code
    import { Menu, Icon } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    const MenuItemGroup = Menu.ItemGroup;
    
    class App extends React.Component {
      state = {
        current: 'mail',
      }
    
      handleClick = (e) => {
        console.log('click ', e);
        this.setState({
          current: e.key,
        });
      }
    
      render() {
        return (
          <Menu
            onClick={this.handleClick}
            selectedKeys={[this.state.current]}
            mode="horizontal"
          >
            <Menu.Item key="mail">
              <Icon type="mail_outline" />Navigation One
            </Menu.Item>
            <Menu.Item key="app" disabled>
              <Icon type="apps" />Navigation Two
            </Menu.Item>
            <SubMenu title={<span><Icon type="settings" />Navigation Three - Submenu</span>}>
              <MenuItemGroup title="Item 1">
                <Menu.Item key="setting:1">Option 1</Menu.Item>
                <Menu.Item key="setting:2">Option 2</Menu.Item>
              </MenuItemGroup>
              <MenuItemGroup title="Item 2">
                <Menu.Item key="setting:3">Option 3</Menu.Item>
                <Menu.Item key="setting:4">Option 4</Menu.Item>
              </MenuItemGroup>
            </SubMenu>
            <Menu.Item key="alipay">
              <a href="https://github.com/choerodon" target="_blank" rel="noopener noreferrer">Navigation Four - Link</a>
            </Menu.Item>
          </Menu>
        );
      }
    }
    
    ReactDOM.render(<App />, mountNode);
    
    垂直菜单,子菜单内嵌在菜单区域。
    expand code expand code
    import { Menu, Icon } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    const MenuItemGroup = Menu.ItemGroup;
    
    class Sider extends React.Component {
      handleClick = (e) => {
        console.log('click ', e);
      }
    
      render() {
        return (
          <Menu
            onClick={this.handleClick}
            style={{ width: 256 }}
            defaultSelectedKeys={['1']}
            defaultOpenKeys={['sub1']}
            mode="inline"
          >
            <SubMenu key="sub1" title={<span><Icon type="mail_outline" /><span>Navigation One</span></span>}>
              <MenuItemGroup key="g1" title="Item 1">
                <Menu.Item key="1">Option 1</Menu.Item>
                <Menu.Item key="2">Option 2</Menu.Item>
              </MenuItemGroup>
              <MenuItemGroup key="g2" title="Item 2">
                <Menu.Item key="3">Option 3</Menu.Item>
                <Menu.Item key="4">Option 4</Menu.Item>
              </MenuItemGroup>
            </SubMenu>
            <SubMenu key="sub2" title={<span><Icon type="apps" /><span>Navigation Two</span></span>}>
              <Menu.Item key="5">Option 5</Menu.Item>
              <Menu.Item key="6">Option 6</Menu.Item>
              <SubMenu key="sub3" title="Submenu">
                <Menu.Item key="7">Option 7</Menu.Item>
                <Menu.Item key="8">Option 8</Menu.Item>
              </SubMenu>
            </SubMenu>
            <SubMenu key="sub4" title={<span><Icon type="settings" /><span>Navigation Three</span></span>}>
              <Menu.Item key="9">Option 9</Menu.Item>
              <Menu.Item key="10">Option 10</Menu.Item>
              <Menu.Item key="11">Option 11</Menu.Item>
              <Menu.Item key="12">Option 12</Menu.Item>
            </SubMenu>
          </Menu>
        );
      }
    }
    
    ReactDOM.render(<Sider />, mountNode);
    
    内嵌菜单可以被缩起/展开。
    expand code expand code
    import { Menu, Icon, Button } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    
    class App extends React.Component {
      state = {
        collapsed: false,
      }
    
      toggleCollapsed = () => {
        this.setState({
          collapsed: !this.state.collapsed,
        });
      }
    
      render() {
        return (
          <div style={{ width: 256 }}>
            <Button type="primary" onClick={this.toggleCollapsed} style={{ marginBottom: 16 }}>
              <Icon type={this.state.collapsed ? 'folder_open' : 'folder'} />
            </Button>
            <Menu
              defaultSelectedKeys={['1']}
              defaultOpenKeys={['sub1']}
              mode="inline"
              inlineCollapsed={this.state.collapsed}
            >
              <Menu.Item key="1">
                <Icon type="pie_chart_outlined" />
                <span>Option 1</span>
              </Menu.Item>
              <Menu.Item key="2">
                <Icon type="desktop_windows" />
                <span>Option 2</span>
              </Menu.Item>
              <Menu.Item key="3">
                <Icon type="inbox" />
                <span>Option 3</span>
              </Menu.Item>
              <SubMenu key="sub1" title={<span><Icon type="mail_outline" /><span>Navigation One</span></span>}>
                <Menu.Item key="5">Option 5</Menu.Item>
                <Menu.Item key="6">Option 6</Menu.Item>
                <Menu.Item key="7">Option 7</Menu.Item>
                <Menu.Item key="8">Option 8</Menu.Item>
              </SubMenu>
              <SubMenu key="sub2" title={<span><Icon type="apps" /><span>Navigation Two</span></span>}>
                <Menu.Item key="9">Option 9</Menu.Item>
                <Menu.Item key="10">Option 10</Menu.Item>
                <SubMenu key="sub3" title="Submenu">
                  <Menu.Item key="11">Option 11</Menu.Item>
                  <Menu.Item key="12">Option 12</Menu.Item>
                </SubMenu>
              </SubMenu>
            </Menu>
          </div>
        );
      }
    }
    
    ReactDOM.render(<App />, mountNode);
    
    点击菜单,收起其他展开的所有菜单,保持菜单聚焦简洁。
    expand code expand code
    import { Menu, Icon } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    
    class Sider extends React.Component {
      // submenu keys of first level
      rootSubmenuKeys = ['sub1', 'sub2', 'sub4'];
    
      state = {
        openKeys: ['sub1'],
      }
    
      onOpenChange = (openKeys) => {
        const latestOpenKey = openKeys.find(key => this.state.openKeys.indexOf(key) === -1);
        if (this.rootSubmenuKeys.indexOf(latestOpenKey) === -1) {
          this.setState({ openKeys });
        } else {
          this.setState({
            openKeys: latestOpenKey ? [latestOpenKey] : [],
          });
        }
      }
    
      render() {
        return (
          <Menu
            mode="inline"
            openKeys={this.state.openKeys}
            onOpenChange={this.onOpenChange}
            style={{ width: 256 }}
          >
            <SubMenu key="sub1" title={<span><Icon type="mail_outline" /><span>Navigation One</span></span>}>
              <Menu.Item key="1">Option 1</Menu.Item>
              <Menu.Item key="2">Option 2</Menu.Item>
              <Menu.Item key="3">Option 3</Menu.Item>
              <Menu.Item key="4">Option 4</Menu.Item>
            </SubMenu>
            <SubMenu key="sub2" title={<span><Icon type="apps" /><span>Navigation Two</span></span>}>
              <Menu.Item key="5">Option 5</Menu.Item>
              <Menu.Item key="6">Option 6</Menu.Item>
              <SubMenu key="sub3" title="Submenu">
                <Menu.Item key="7">Option 7</Menu.Item>
                <Menu.Item key="8">Option 8</Menu.Item>
              </SubMenu>
            </SubMenu>
            <SubMenu key="sub4" title={<span><Icon type="settings" /><span>Navigation Three</span></span>}>
              <Menu.Item key="9">Option 9</Menu.Item>
              <Menu.Item key="10">Option 10</Menu.Item>
              <Menu.Item key="11">Option 11</Menu.Item>
              <Menu.Item key="12">Option 12</Menu.Item>
            </SubMenu>
          </Menu>
        );
      }
    }
    
    ReactDOM.render(<Sider />, mountNode);
    
    子菜单是弹出的形式。
    expand code expand code
    import { Menu, Icon } from 'choerodon-ui';
    const SubMenu = Menu.SubMenu;
    const MenuItemGroup = Menu.ItemGroup;
    
    function handleClick(e) {
      console.log('click', e);
    }
    
    ReactDOM.render(
      <Menu onClick={handleClick} style={{ width: 256 }} mode="vertical">
        <SubMenu key="sub1" title={<span><Icon type="mail_outline" /><span>Navigation One</span></span>}>
          <MenuItemGroup title="Item 1">
            <Menu.Item key="1">Option 1</Menu.Item>
            <Menu.Item key="2">Option 2</Menu.Item>
          </MenuItemGroup>
          <MenuItemGroup title="Iteom 2">
            <Menu.Item key="3">Option 3</Menu.Item>
            <Menu.Item key="4">Option 4</Menu.Item>
          </MenuItemGroup>
        </SubMenu>
        <SubMenu key="sub2" title={<span><Icon type="apps" /><span>Navigation Two</span></span>}>
          <Menu.Item key="5">Option 5</Menu.Item>
          <Menu.Item key="6">Option 6</Menu.Item>
          <SubMenu key="sub3" title="Submenu">
            <Menu.Item key="7">Option 7</Menu.Item>
            <Menu.Item key="8">Option 8</Menu.Item>
          </SubMenu>
        </SubMenu>
        <SubMenu key="sub4" title={<span><Icon type="settings" /><span>Navigation Three</span></span>}>
          <Menu.Item key="9">Option 9</Menu.Item>
          <Menu.Item key="10">Option 10</Menu.Item>
          <Menu.Item key="11">Option 11</Menu.Item>
          <Menu.Item key="12">Option 12</Menu.Item>
        </SubMenu>
      </Menu>,
      mountNode);
    
    展示动态切换模式。
    expand code expand code
    import { Menu, Icon, Switch } from 'choerodon-ui';
    const { SubMenu } = Menu;
    
    class Sider extends React.Component {
      state = {
        mode: 'inline',
      }
    
      changeMode = (value) => {
        this.setState({
          mode: value ? 'vertical' : 'inline',
        });
      }
    
      render() {
        return (
          <div>
            <Switch onChange={this.changeMode} /> Change Mode
            <span className="ant-divider" style={{ margin: '0 1em' }} />
            <br />
            <br />
            <Menu
              style={{ width: 256 }}
              defaultSelectedKeys={['1']}
              defaultOpenKeys={['sub1']}
              mode={this.state.mode}
            >
              <Menu.Item key="1">
                <Icon type="mail_outline" />
                Navigation One
              </Menu.Item>
              <Menu.Item key="2">
                <Icon type="perm_contact_calendar" />
                Navigation Two
              </Menu.Item>
              <SubMenu key="sub1" title={<span><Icon type="apps" /><span>Navigation Three</span></span>}>
                <Menu.Item key="3">Option 3</Menu.Item>
                <Menu.Item key="4">Option 4</Menu.Item>
                <SubMenu key="sub1-2" title="Submenu">
                  <Menu.Item key="5">Option 5</Menu.Item>
                  <Menu.Item key="6">Option 6</Menu.Item>
                </SubMenu>
              </SubMenu>
              <SubMenu key="sub2" title={<span><Icon type="settings" /><span>Navigation Four</span></span>}>
                <Menu.Item key="7">Option 7</Menu.Item>
                <Menu.Item key="8">Option 8</Menu.Item>
                <Menu.Item key="9">Option 9</Menu.Item>
                <Menu.Item key="10">Option 10</Menu.Item>
              </SubMenu>
            </Menu>
          </div>
        );
      }
    }
    
    ReactDOM.render(<Sider />, mountNode);
    

    API

    <Menu>
      <Menu.Item>菜单项</Menu.Item>
      <SubMenu title="子菜单">
        <Menu.Item>子菜单项</Menu.Item>
      </SubMenu>
    </Menu>
    
    参数说明类型默认值
    defaultOpenKeys初始展开的 SubMenu 菜单项 key 数组
    defaultSelectedKeys初始选中的菜单项 key 数组string[]
    forceSubMenuRender在子菜单展示之前就渲染进 DOMbooleanfalse
    inlineCollapsedinline 时菜单是否收起状态boolean-
    inlineIndentinline 模式的菜单缩进宽度number24
    mode菜单类型,现在支持垂直、水平、和内嵌模式三种string: vertical vertical-right horizontal inlinevertical
    multiple是否允许多选booleanfalse
    openKeys当前展开的 SubMenu 菜单项 key 数组string[]
    selectable是否允许选中booleantrue
    selectedKeys当前选中的菜单项 key 数组string[]
    style根节点样式object
    subMenuCloseDelay用户鼠标离开子菜单后关闭延时,单位:秒number0.1
    subMenuOpenDelay用户鼠标进入子菜单后开启延时,单位:秒number0
    theme主题颜色string: light darklight
    onClick点击 MenuItem 调用此函数function({ item, key, keyPath })-
    onDeselect取消选中时调用,仅在 multiple 生效function({ item, key, selectedKeys })-
    onOpenChangeSubMenu 展开/关闭的回调function(openKeys: string[])noop
    onSelect被选中时调用function({ item, key, selectedKeys })无  

    More options in rc-menu

    参数说明类型默认值
    disabled是否禁用booleanfalse
    keyitem 的唯一标志string
    参数说明类型默认值
    children子菜单的菜单项Array<MenuItem|SubMenu>
    disabled是否禁用booleanfalse
    key唯一标志string
    title子菜单项值string|ReactNode
    onTitleClick点击子菜单标题function({ key, domEvent })
    参数说明类型默认值
    children分组的菜单项MenuItem[]
    title分组标题string|ReactNode

    菜单项分割线,只用在弹出菜单内。