Skip to content

ContextMenuGroup

子菜单组件。

Props

属性描述类型默认值
label菜单项名称string
icon菜单项图标string
iconFontClass自定义图标字体类名stringiconfont
preserveIconWidth是否应为没有图标的菜单项保留固定宽度的图标区域booleantrue
svgIcon菜单项图标 svg,仅在 icon 为空时有效string
svgProps当使用 svg 图标时,自定义 svg 标签属性SVGAttributes
disabled是否禁用菜单项booleanfalse
checked是否选中菜单项booleanfalse
shortcut当前菜单项的快捷键指示,此快捷键只用于显示给用户看,快捷键的注册还是需要你自己处理string''
clickableWhenHasChildren指定当本菜单下有子菜单时,点击当前菜单是否触发点击事件booleanfalse
adjustSubMenuPosition默认情况下,子菜单将自动调整其位置,以防止溢出容器。如果允许菜单溢出容器,可以将其设置为falseboolean继承自 MenuOptions.adjustPosition
clickClose点击当前菜单项是否自动关闭整个菜单booleantrue
customClass自定义子菜单classstring
minWidth子菜单最小宽度number100
maxWidth子菜单最大宽度number600
onClick菜单项点击事件Function()

Slots

插槽名描述参数
default子菜单渲染插槽-

ContextMenuGroupRef

getSubMenuRef(): ContextSubMenuInstance

获取当前子菜单实例。

返回值

说明
ContextSubMenuInstance

getMenuItemRef(): ContextSubMenuInstance

获取当菜单条目控制实例。

返回值

说明
MenuItemContext

ContextSubMenuInstance

表示弹出菜单的控制实例,使用它可以控制菜单的更复杂的控制,包括获取菜单项,获取高度,位置,滚动,设置滚动数值,位置等等。

函数模式下可以从 ContextMenuInstance.getMenuRef 获取。

getSubmenuRoot(): HTMLElement

获取当前子菜单的显示根元素。

getMenu(): HTMLElement

获取当前子菜单的内容容器元素。

getChildItem(index: number) : MenuItemContext | undefined

通过数组索引获取子菜单项控制实例,只有在显示父子菜单后才能检索子菜单项。

参数

参数说明
index菜单项索引。

返回值

说明
可以根据索引获取控制实例 MenuItemContext,以实现对菜单项的实时控制。

getMenuDimensions(): { width: number, height: number }

获取当前子菜单的大小。

返回值

说明
以像素为单位返回根菜单大小,如果菜单未显示则返回全零。

getScrollValue(): number

获取子菜单当前滚动值 (与 element.scrollTop 相同)。

getScrollHeight(): number

获取子菜单当前滚动高度 (与 element.scrollHeight 相同)。

getMaxHeight(): number

获取子菜单的最高高度。

getPosition(): { width: number, height: number }

获取子菜单当前位置(相对于父项)。

setScrollValue(v: number): void

设置子菜单当前滚动值 (与 element.scrollTop 相同)。

参数

参数说明
v菜单滚动高度。

setPosition(x: number, y: number): void

设置子菜单当前位置(相对于父项)。

参数

参数说明
xX轴位置
yY轴位置

Released under the MIT License.