@neosjs/contextmenu
右键菜单指令。以 v-contextmenu 指令的形式使用,右键目标元素时在鼠标位置弹出菜单,支持二级子菜单、分隔线、禁用与隐藏项,菜单位置自动避免溢出屏幕。
安装
sh
pnpm add @neosjs/contextmenush
npm i @neosjs/contextmenush
yarn add @neosjs/contextmenu快速上手
指令的值为一个函数:接收触发右键的元素,返回菜单配置数组(返回空值则不弹出菜单)。局部注册方式如下。
vue
<script setup lang="ts">
import type { ContextmenuItem } from '@neosjs/contextmenu'
import contextmenu from '@neosjs/contextmenu'
function menus(el: HTMLElement): ContextmenuItem[] {
return [
{
text: '复制',
subText: 'Ctrl + C',
handler: () => {
console.log('复制')
}
},
{ divider: true },
{
text: '删除',
handler: () => {
console.log('删除', el)
}
}
]
}
</script>
<template>
<div v-contextmenu="menus">
右键点击此区域
</div>
</template>菜单项配置
ContextmenuItem 支持的字段:
| 字段 | 类型 | 说明 |
|---|---|---|
| text | string | 菜单项文字 |
| subText | string | 右侧次要文字(如快捷键),有子菜单时不显示 |
| divider | boolean | 是否为分隔线 |
| disable | boolean | 是否禁用(不可点击) |
| hide | boolean | 是否隐藏该项 |
| children | ContextmenuItem[] | 子菜单,悬停时在右侧展开 |
| handler | (el: HTMLElement) => void | 点击回调,参数为触发右键的元素 |
ts
// 二级子菜单示例
function menus(el: HTMLElement): ContextmenuItem[] {
return [
{
text: '排序',
children: [
{
text: '按名称',
handler: () => {}
},
{
text: '按时间',
handler: () => {}
}
]
}
]
}TIP
点击菜单项、左键点击遮罩或在遮罩上再次右键会关闭菜单;页面滚动或窗口尺寸变化时菜单也会自动移除。触发元素在菜单激活期间会被添加 contextmenu-active 类名,可用于高亮。