Menu导航菜单
Menu
导航菜单
使用import { Menu } from 'antd'; |
导航菜单是一个网站的灵魂，用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航，顶部导航提供全局性的类目和功能，侧边导航提供多级结构来收纳和排列网站架构。
更多布局和导航的使用可以参考：通用布局。
ul，因而仅支持 li 以及 script-supporting 子元素。因而你的子节点元素应该都在 Menu.Item 内使用。Menu.* 以及对此进行封装的 HOC 组件。通用属性参考：通用属性
| 参数 | 说明 | 类型 | 默认值 | 版本 | 全局配置 |
|---|---|---|---|---|---|
| classNames | 用于自定义组件内部各语义化结构的 class，支持对象或函数 | Record<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string> | - | 6.0.0 | |
| defaultOpenKeys | 初始展开的 SubMenu 菜单项 key 数组 | string[] | - | × | |
| defaultSelectedKeys | 初始选中的菜单项 key 数组 | string[] | - | × | |
| expandIcon | 自定义展开图标 | ReactNode | (props: SubMenuProps & { isSubMenu: boolean }) => ReactNode | - | 4.9.0 | 5.15.0 |
| forceSubMenuRender | 在子菜单展示之前就渲染进 DOM | boolean | false | × | |
| inlineCollapsed | inline 时菜单是否收起状态 | boolean | - | × | |
| inlineIndent | inline 模式的菜单缩进宽度 | number | 24 | × | |
| items | 菜单内容 | 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[] | - | × | |
| styles | 用于自定义组件内部各语义化结构的行内 style，支持对象或函数 | Record<SemanticDOM , CSSProperties> | (info: { props }) => Record<SemanticDOM , CSSProperties> | - | 6.0.0 | |
| subMenuCloseDelay | 用户鼠标离开子菜单后关闭延时，单位：秒 | number | 0.1 | × | |
| subMenuOpenDelay | 用户鼠标进入子菜单后开启延时，单位：秒 | number | 0 | × | |
| tooltip | 配置 inline 折叠时的 MenuItem 悬浮提示，设为 false 可关闭 | false | TooltipProps | - | 6.3.0 | × |
| theme | 主题颜色 | light | dark | light | × | |
| triggerSubMenuAction | SubMenu 展开/关闭的触发行为 | hover | click | hover | × | |
| onClick | 点击 MenuItem 调用此函数 | function({ key, keyPath, domEvent, itemData }) | - | × | |
| onDeselect | 取消选中时调用，仅在 multiple 生效 | function({ key, keyPath, selectedKeys, domEvent, itemData }) | - | × | |
| onOpenChange | SubMenu 展开/关闭的回调 | function(openKeys: string[]) | - | × | |
| onSelect | 被选中时调用 | function({ key, keyPath, selectedKeys, domEvent, itemData }) | - | × | |
| popupRender | 自定义子菜单的弹出框 | (node: ReactElement, props: { item: SubMenuProps; keys: string[] }) => ReactElement | - | × |
更多属性查看 @rc-component/menu
type ItemType = MenuItemType | SubMenuType | MenuItemGroupType | MenuDividerType;
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| danger | 展示错误状态样式 | boolean | false | |
| disabled | 是否禁用 | boolean | false | |
| extra | 额外节点 | ReactNode | - | 5.21.0 |
| icon | 菜单图标 | ReactNode | - | |
| key | item 的唯一标志 | string | - | |
| label | 菜单项标题 | ReactNode | - | |
| title | 设置收缩时展示的悬浮标题 | string | - |
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| children | 子菜单的菜单项 | 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 | - | |
| popupRender | 自定义当前子菜单的弹出框 | (node: ReactElement, props: { item: SubMenuProps; keys: string[] }) => ReactElement | - |
定义类型为 group 时，会作为分组处理:
const groupItem = {type: 'group', // Must havelabel: 'My Group',children: [],};
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| children | 分组的菜单项 | MenuItemType[] | - | |
| label | 分组标题 | ReactNode | - |
菜单项分割线，只用在弹出菜单内，需要定义类型为 divider：
const dividerItem = {type: 'divider', // Must have};
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| dashed | 是否虚线 | boolean | false |
Menu 通过二次渲染收集嵌套结构信息以支持 HOC 的结构。合并成一个推导结构会使得逻辑变得十分复杂，欢迎 PR 以协助改进该设计。
Menu 初始化时会先全部渲染，然后根据宽度裁剪内容。当处于 Flex 布局中，你需要告知其预期宽度为响应式宽度（在线 Demo）：
<div style={{ flex }}><div style={{ ... }}>Some Content</div><Menu style={{ minWidth: 0, flex: "auto" }} /></div>
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| activeBarBorderWidth | 菜单项指示条边框宽度 | string | number | 1 |
| activeBarHeight | 菜单项指示条高度 | number | 2 |
| activeBarWidth | 菜单项指示条宽度 | string | number | 0 |
| collapsedIconSize | 收起时图标尺寸 | number | 16 |
| collapsedWidth | 收起后的宽度 | string | number | 80 |
| dangerItemActiveBg | 危险菜单项激活态背景色 | string | #fff2f0 |
| dangerItemColor | 危险菜单项文字颜色 | string | #ff4d4f |
| dangerItemHoverColor | 危险菜单项文字悬浮颜色 | string | #ff4d4f |
| dangerItemSelectedBg | 危险菜单项选中背景色 | string | #fff2f0 |
| dangerItemSelectedColor | 危险菜单项文字选中颜色 | string | #ff4d4f |
| darkDangerItemActiveBg | 暗色模式下的危险菜单项激活态背景 | string | #ff4d4f |
| darkDangerItemColor | 暗色模式下的危险菜单项文字颜色 | string | #ff4d4f |
| darkDangerItemHoverColor | 暗色模式下的危险菜单项悬浮文字背景 | string | #ff7875 |
| darkDangerItemSelectedBg | 暗色模式下的危险菜单项选中背景 | string | #ff4d4f |
| darkDangerItemSelectedColor | 暗色模式下的危险菜单项选中文字颜色 | string | #fff |
| darkGroupTitleColor | 暗色模式下的分组标题文字颜色 | string | rgba(255,255,255,0.65) |
| darkItemBg | 暗色模式下的菜单项背景 | string | #001529 |
| darkItemColor | 暗色模式下的菜单项文字颜色 | string | rgba(255,255,255,0.65) |
| darkItemDisabledColor | 暗色模式下的菜单项禁用颜色 | string | rgba(255,255,255,0.25) |
| darkItemHoverBg | 暗色模式下的菜单项悬浮背景 | string | transparent |
| darkItemHoverColor | 暗色模式下的菜单项悬浮颜色 | string | #fff |
| darkItemSelectedBg | 暗色模式下的菜单项选中背景 | string | #1677ff |
| darkItemSelectedColor | 暗色模式下的菜单项选中颜色 | string | #fff |
| darkPopupBg | 暗色模式下的浮层菜单的背景颜色 | string | #001529 |
| darkSubMenuItemBg | 暗色模式下的子菜单项背景 | string | #000c17 |
| dropdownWidth | 弹出菜单的宽度 | string | number | 160 |
| groupTitleColor | 分组标题文字颜色 | string | rgba(0,0,0,0.45) |
| groupTitleFontSize | 分组标题文字大小 | number | 14 |
| groupTitleLineHeight | 分组标题文字高度 | string | number | 1.5714285714285714 |
| horizontalItemBorderRadius | 横向菜单项圆角 | number | 0 |
| horizontalItemHoverBg | 横向菜单项横悬浮态背景色 | string | transparent |
| horizontalItemHoverColor | 水平菜单项文字悬浮颜色 | string | #1677ff |
| horizontalItemSelectedBg | 水平菜单项选中态背景色 | string | transparent |
| horizontalItemSelectedColor | 水平菜单项文字选中颜色 | string | #1677ff |
| horizontalLineHeight | 横向菜单行高 | LineHeight<string | number> | undefined | 46px |
| iconMarginInlineEnd | 图标与文字间距 | MarginInlineEnd<string | number> | undefined | 10 |
| iconSize | 图标尺寸 | number | 14 |
| itemActiveBg | 菜单项激活态背景色 | string | #e6f4ff |
| itemBg | 菜单项背景色 | string | #ffffff |
| itemBorderRadius | 菜单项的圆角 | number | 8 |
| itemColor | 菜单项文字颜色 | string | rgba(0,0,0,0.88) |
| itemDisabledColor | 菜单项文字禁用颜色 | string | rgba(0,0,0,0.25) |
| itemHeight | 菜单项高度 | string | number | 40 |
| itemHoverBg | 菜单项悬浮态背景色 | string | rgba(0,0,0,0.06) |
| itemHoverColor | 菜单项文字悬浮颜色 | string | rgba(0,0,0,0.88) |
| itemMarginBlock | 菜单项纵向外间距 | MarginBlock<string | number> | undefined | 4 |
| itemMarginInline | 菜单项横向外间距 | number | 4 |
| itemPaddingInline | 菜单项横向内间距 | PaddingInline<string | number> | undefined | 16 |
| itemSelectedBg | 菜单项选中态背景色 | string | #e6f4ff |
| itemSelectedColor | 菜单项文字选中颜色 | string | #1677ff |
| popupBg | 弹出框背景色 | string | #ffffff |
| subMenuItemBg | 子菜单项背景色 | string | rgba(0,0,0,0.02) |
| subMenuItemBorderRadius | 子菜单项的圆角 | number | 4 |
| subMenuItemSelectedColor | 子菜单内有选中项时，子菜单标题色 | string | #1677ff |
| zIndexPopup | 弹出菜单的 z-index | number | 1050 |
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| colorBgElevated | 浮层容器背景色，在暗色模式下该 token 的色值会比 `colorBgContainer` 要亮一些。例如：模态框、弹出框、菜单等。 | string | #ffffff |
| colorPrimaryBorder | 主色梯度下的描边用色，用在 Slider 等组件的描边上。 | string | #91caff |
| colorSplit | 用于作为分割线的颜色，此颜色和 colorBorderSecondary 的颜色一致，但是用的是透明色。 | string | rgba(5,5,5,0.06) |
| colorText | 最深的文本色。为了符合W3C标准，默认的文本颜色使用了该色，同时这个颜色也是最深的中性色。 | string | rgba(0,0,0,0.88) |
| colorTextLightSolid | 控制带背景色的文本，例如 Primary Button 组件中的文本高亮颜色。 | string | #fff |
| borderRadius | 基础组件的圆角大小，例如按钮、输入框、卡片等 | number | 6 |
| borderRadiusLG | LG号圆角，用于组件中的一些大圆角，如 Card、Modal 等一些组件样式。 | number | 8 |
| boxShadowSecondary | 控制元素二级阴影样式。 | string | 0 6px 16px 0 rgba(0,0,0,0.08), 0 3px 6px -4px rgba(0,0,0,0.12), 0 9px 28px 8px rgba(0,0,0,0.05) |
| controlHeightLG | 较高的组件高度 | number | 40 |
| fontFamily | Ant Design 的字体家族中优先使用系统默认的界面字体，同时提供了一套利于屏显的备用字体库，来维护在不同平台以及浏览器的显示下，字体始终保持良好的易读性和可读性，体现了友好、稳定和专业的特性。 | string | -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji' |
| fontSize | 设计系统中使用最广泛的字体大小，文本梯度也将基于该字号进行派生。 | number | 14 |
| fontSizeLG | 大号字体大小 | number | 16 |
| lineHeight | 文本行高 | number | 1.5714285714285714 |
| lineType | 用于控制组件边框、分割线等的样式，默认是实线 | string | solid |
| lineWidth | 用于控制组件边框、分割线等的宽度 | number | 1 |
| lineWidthFocus | 控制线条的宽度，当组件处于聚焦态时。 | number | 3 |
| margin | 控制元素外边距，中等尺寸。 | number | 16 |
| marginXS | 控制元素外边距，小尺寸。 | number | 8 |
| motionDurationFast | 动效播放速度，快速。用于小型元素动画交互 | string | 0.1s |
| motionDurationMid | 动效播放速度，中速。用于中型元素动画交互 | string | 0.2s |
| motionDurationSlow | 动效播放速度，慢速。用于大型元素如面板动画交互 | string | 0.3s |
| motionEaseInOut | 预设动效曲率 | string | |
| motionEaseInOutCirc | 预设动效曲率 | string | |
| motionEaseInQuint | 预设动效曲率 | string | |
| motionEaseOut | 预设动效曲率 | string | |
| motionEaseOutCirc | 预设动效曲率 | string | |
| motionEaseOutQuint | 预设动效曲率 | string | |
| padding | 控制元素的内间距。 | number | 16 |
| paddingXL | 控制元素的特大内间距。 | number | 32 |
| paddingXS | 控制元素的特小内间距。 | number | 8 |