ant-design-vue/components/menu/index.zh-CN.md

4.3 KiB
Raw Blame History

category cols type title subtitle cover
Components 1 导航 Menu 导航菜单 https://gw.alipayobjects.com/zos/alicdn/3XZcjGpvK/Menu.svg

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

何时使用

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

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

API

<template>
  <a-menu>
    <a-menu-item>菜单项</a-menu-item>
    <a-sub-menu key="sub1" title="子菜单">
      <a-menu-item>子菜单项</a-menu-item>
    </a-sub-menu>
  </a-menu>
</template>

Menu

参数 说明 类型 默认值
forceSubMenuRender 在子菜单展示之前就渲染进 DOM boolean false
inlineCollapsed inline 时菜单是否收起状态 boolean -
inlineIndent inline 模式的菜单缩进宽度 number 24
mode 菜单类型,现在支持垂直、水平、和内嵌模式三种 vertical | horizontal | inline vertical
multiple 是否允许多选 boolean false
openKeys(v-model) 当前展开的 SubMenu 菜单项 key 数组 string[]
selectable 是否允许选中 boolean true
selectedKeys(v-model) 当前选中的菜单项 key 数组 string[]
subMenuCloseDelay 用户鼠标离开子菜单后关闭延时,单位:秒 number 0.1
subMenuOpenDelay 用户鼠标进入子菜单后开启延时,单位:秒 number 0
theme 主题颜色 string: light dark light
overflowedIndicator 自定义 Menu 折叠时的图标 DOM <span>···</span>
triggerSubMenuAction 修改 Menu 子菜单的触发方式 click | hover hover

Menu 事件

事件名称 说明 回调参数
click 点击 MenuItem 调用此函数 function({ item, key, keyPath })
deselect 取消选中时调用,仅在 multiple 生效 function({ item, key, selectedKeys })
openChange SubMenu 展开/关闭的回调 function(openKeys: string[])
select 被选中时调用 function({ item, key, selectedKeys })

Menu.Item

参数 说明 类型 默认值 版本
disabled 是否禁用 boolean false
key item 的唯一标志 string
title 设置收缩时展示的悬浮标题 string/slot
icon 菜单图标 slot 2.8.0

Menu.SubMenu

参数 说明 类型 默认值 版本
popupClassName 子菜单样式 string 1.5.0
disabled 是否禁用 boolean false
key 唯一标志, 必填 string
title 子菜单项值 string|slot
expandIcon 自定义 Menu 展开收起图标 slot 箭头图标
icon 菜单图标 slot 2.8.0

Menu.SubMenu 的子元素必须是 MenuItem 或者 SubMenu.

SubMenu 必须传递 key如不传递该 SubMenu 下子元素将提前渲染,而且部分场景无法进行有效高亮。

SubMenu 事件

事件名称 说明 回调参数
titleClick 点击子菜单标题 ({ key, domEvent })

Menu.ItemGroup

参数 说明 类型 默认值
title 分组标题 string||function|slot

Menu.ItemGroup 的子元素必须是 MenuItem.

Menu.Divider

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