此页面由社区从英文翻译而来。了解更多并加入 MDN Web Docs 社区。

View in English Always switch to English

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("切换功能!"); } }); 

示例扩展

浏览器兼容性

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