onCommand

当使用关联的键盘快捷键执行命令时触发。

侦听器将传递命令的名称。这与在 manifest.json 条目中赋予命令的名称相匹配。

语法

browser.commands.onCommand.addListener(listener)
browser.commands.onCommand.removeListener(listener)
browser.commands.onCommand.hasListener(listener)

事件具有三个函数

addListener(listener): 为该事件添加侦听器。
removeListener(listener): 停止侦听此事件。listener 参数是要移除的侦听器。
hasListener(listener): 检查是否为该事件注册了 listener。如果正在侦听，则返回 true，否则返回 false。

addListener 语法

参数

listener

当用户输入命令快捷键时调用的函数。该函数将传递以下参数

name: string。命令的名称。这与在 manifest.json 条目中赋予命令的名称相匹配。
tab: tabs.Tab。输入命令快捷键时处于活动状态的选项卡。

示例

给定如下所示的 manifest.json 条目

json

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    },
    "description": "Send a 'toggle-feature' event"
  }
}

您可以像这样侦听此特定命令

browser.commands.onCommand.addListener((command) => {
  if (command === "toggle-feature") {
    console.log("toggling the feature!");
  }
});

扩展示例

命令

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

注意：此 API 基于 Chromium 的 chrome.commands API。