onCommand

Syntax

chrome.commands.onCommand.addListener(function(
  command      // string
) {...})
chrome.commands.onCommand.removeListener(listener)
chrome.commands.onCommand.hasListener(listener)

This API is also available as browser.commands.onCommand.*.

Events have three functions:

addListener(callback)

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

Function that will be called when a user enters the command's shortcut. The function will be passed the following arguments:

name

string. Name of the command. This matches the name given to the command in its manifest.json entry.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Examples

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

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

Example add-ons

• commands