onCommand
Fired when a command is executed using its associated keyboard shortcut.
The event passes the listener the command's name. This name matches the name given to the command in its manifest.json entry.
Syntax
browser.commands.onCommand.addListener(listener)
browser.commands.onCommand.removeListener(listener)
browser.commands.onCommand.hasListener(listener)
Events have three functions:
addListener(listener)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener-
The function called when a user enters the command's shortcut. The function is passed these arguments:
name-
string. Name of the command. This name matches the name given to the command in its manifest.json entry. tab-
tabs.Tab. The tab that was active when the command shortcut was entered.
Examples
Given a manifest.json entry like this:
"commands": {
"toggle-feature": {
"suggested_key": {
"default": "Ctrl+Shift+Y"
},
"description": "Send a 'toggle-feature' event"
}
}
You could listen for this command like this:
browser.commands.onCommand.addListener((command) => {
if (command === "toggle-feature") {
console.log("toggling the feature!");
}
});
You could listen for this command and send a message to any content scripts or extension pages or iframe in the active tab so that they can act on the command, like this:
browser.commands.onCommand.addListener((command, tab) => {
if (command === "toggle-feature") {
console.log("toggling the feature!");
console.log("Command triggered on tab:", tab.id, tab.url);
browser.tabs.sendMessage(tab.id, {
type: "toggle-feature",
tabId: tab.id,
url: tab.url,
});
}
});
Example extensions
Browser compatibility
Note:
This API is based on Chromium's chrome.commands API.