onCommand

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

监听器将接收命令的名称。这与在 manifest.json 条目中为命令指定的名称相匹配。

语法

js
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 语法

参数

监听器

当用户输入命令的快捷方式时调用的函数。该函数将接收以下参数

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"
  }
}

你可以像这样监听这个特定的命令

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

扩展程序示例

浏览器兼容性

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