Skip to main content

Context menu

Context menu menu is the context menu that appears when the right click on the player.

Configuration#

可以通过 contextMenus 和 contextMenuToggle 来设置右键菜单，它们的默认值如下。

new Player({
contextMenus: ['loop', 'pip', 'version'],
contextMenuToggle: true
})
  • contextMenus 默认有三个菜单项，分别是循环播放、画中画和播放器版本。当为空数组时，单击右键将不会出现右键菜单。
  • contextMenuToggle 是用于配置是否显示原生右键菜单，为 true 时，将在第二次单击时显示浏览器的原生右键菜单，而不是播放器右键菜单。为 false 时，将始终不显示浏览器右键菜单。

内置右键菜单项#

Menu Item IDDescription
loop是否循环播放视频
pip视频画中画，如果不支持则会隐藏
versionNPlayer 版本号

Custom menu item#

interface ContextMenuItem {
id?: string; // 菜单项 id 一般只在菜单项中才会使用
html?: string; // 菜单文字，可以使用 html 字符串
disabled?: boolean; // 是否禁用
invisible?: boolean; // 是否可见
checked?: boolean; // 是否是选中状态
init?: (player: Player, item: ContextMenuItem) => void; // 初始化时会调用一次
show?: (player: Player, item: ContextMenuItem) => void; // 每次右键菜单展示时会调用
click?: (player: Player, item: ContextMenuItem) => void; // 用户单击该项会调用
}
caution

html 属性，会直接使用 innerHTML 设置到 DOM，不会经过安全处理。需要自己保障字符串安全。

可以自己实现一个画中画菜单项。

const MyPIP = {
html: '我的画中画',
init() {
this.invisible = !('pictureInPictureEnabled' in document);
// 初始化是判断浏览器是否不支持，不支持则隐藏自己
},
click(player) {
if (player.video.readyState < 3) return; // 视频还没加载成功
if (document.pictureInPictureElement !== player.video) {
player.video.requestPictureInPicture()
} else {
document.exitPictureInPicture()
}
}
}
new Player({
contextMenus: ['loop', 'pip', MyPIP, 'version']
})

新建了一个自己的画中画项，然后把它加入到内置的画中画菜单项下方。

Getting and registering menu items#

player 提供了两个方法来注册和获取菜单项对象。

registerContextMenuItem(item: ContextMenuItem, id?: string)#

可以使用该方法注册菜单项目，然后使用 id 字符串访问，一般只会在自定义插件中会使用。详情请查看 插件。

getContextMenuItem(id: string): ContextMenuItem | null#

可以用该方法获取指定 id 的菜单项。

const player = new Player()
const pip = player.getContextMenuItem('pip')
if (pip) {
pip.disabled = true
pip.html = '我的PIP'
}
info

对于 contextmenu 的配置项，你可以随便修改它的字段，在下一次展示右键菜单时，会使用最新的值。

Examples#

Edit this page