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

参数

listener

用户输入命令的快捷键时调用的函数。该函数接收以下参数:

name

string。命令的名称。这与在其 manifest.json 条目中给出的名称相匹配。

tab

tabs.Tab。输入命令快捷键时激活的标签页。

示例

给出这样的 manifest.json 条目:

json
"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    },
    "description": "发送一个“toggle-feature”事件"
  }
}

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

js
browser.commands.onCommand.addListener((command) => {
  if (command === "toggle-feature") {
    console.log("切换功能!");
  }
});

示例扩展

浏览器兼容性

BCD tables only load in the browser

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