onCommand

Wird ausgelöst, wenn ein Befehl über die zugehörige Tastenkombination ausgeführt wird.

Dem Listener wird der Name des Befehls übergeben. Dieser entspricht dem im manifest.json-Eintrag angegebenen Namen.

Syntax

js
browser.commands.onCommand.addListener(listener)
browser.commands.onCommand.removeListener(listener)
browser.commands.onCommand.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Hört auf, auf dieses Ereignis zu hören. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

Überprüft, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn er lauscht, andernfalls false.

Syntax von addListener

Parameter

listener

Die Funktion, die aufgerufen wird, wenn ein Benutzer die Tastenkombination für den Befehl eingibt. Der Funktion werden folgende Argumente übergeben:

name

string. Name des Befehls. Dieser entspricht dem Namen, der im manifest.json-Eintrag angegeben ist.

tab

tabs.Tab. Der Tab, der aktiv war, als die Befehlstastenkombination eingegeben wurde.

Beispiele

Bei einem manifest.json-Eintrag wie diesem:

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

Könnten Sie auf diesen bestimmten Befehl wie folgt lauschen:

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

Beispielerweiterungen

Browser-Kompatibilität

Hinweis: Diese API basiert auf Chromiums chrome.commands API.