--- title: commands slug: Mozilla/Add-ons/WebExtensions/manifest.json/commands tags: - Add-ons Erweiterungen WebExtensions translation_of: Mozilla/Add-ons/WebExtensions/manifest.json/commands ---
Typ | Objekt |
---|---|
Obligatorisch | Nein |
Beispiel |
"commands": { "toggle-feature": { "suggested_key": { "default": "Ctrl+Shift+Y", "linux": "Ctrl+Shift+U" }, "description": "Ereignis 'toggle-feature' senden" } } |
Verwenden Sie dencommands-Schlüssel, um für Ihre Erweiterung eine oder mehrere Tastenkürzel zu definieren
.
Jedes Tastenkürzel wird mit einem Namen, eine Kombination von Tasten und einer Beschreibung definiert. Sobald Sie einige Befehle in der manifest.json definiert haben, können Sie die zugewiesenen Tastenkombinationen mittels der JavaScript-API {{WebExtAPIRef("commands")}} verwenden.
Der commands-Schlüssel
ist ein Objekt, und jedes Tastenkürzel ist eine Eigenschaft von ihm. Der Name der Eigenschaft ist der Name des Tastenkürzels.
Jedes Tastenkürzel ist selbst ein Objekt, das bis zu zwei Eigenschaften hat:
suggested_key
: diese definiert die Tastenkombinationdescription
: eine Zeichenkette, die dieses Tastenkürzel beschreibtDie Eigenschaft suggested_key
ist selbst ein Objekt, das folgende Eigenschaften haben kann, die alle Zeichenketten sind:
"default"
, "mac"
, "linux"
, "windows"
, "chromeos"
, "android"
, "ios"
Der Wert jeder Eigenschaft ist das Tastenkürzel für den Befehl auf der angegebenen Plattform, der als Zeichenkette angegeben wird, die die durch ein „+“ voneinander getrennten Tasten enthält. Der Wert für „default“
wird auf allen Plattformen verwendet, die nicht ausdrücklich angegeben sind.
Beispiel:
"commands": { "toggle-feature": { "suggested_key": { "default": "Alt+Shift+U", "linux": "Ctrl+Shift+U" }, "description": "'toggle-feature'-Ereignis an die Erweiterung senden" }, "do-another-thing": { "suggested_key": { "default": "Ctrl+Shift+Y" } } }
Dies definiert zwei Tastenkürzel:
Sie könnten dann den ersten dieser Befehle mit einem Code wie diesen verwenden:
browser.commands.onCommand.addListener(function(command) { if (command == "toggle-feature") { console.log("toggling the feature!"); } });
Es gibt drei besondere Tastenkürzel:
Dies definiert zum Beispiel eine Tastenkombination, um auf die Browseraktion der Erweiterung zu klicken:
"commands": { "_execute_browser_action": { "suggested_key": { "default": "Ctrl+Shift+Y" } } }
Es gibt zwei gültige Formate für Tastenkürzel: als Tastenkombination oder als Medien-Taste.
Tastenkombinationen müssen aus zwei oder mehr Tasten bestehen:
Die Taste wird dann als Zeichenkette angegeben, die den Satz an Tastenwerten enthält, in der oben angegebenen Reihenfolge, getrennt durch "+": zum Beispiel "Ctrl+Shift+Z".
Wenn eine Tastenkombination bereits vom Browser (zum Beispiel "Ctrl+P") oder durch ein bestehendes Add-on verwendet wird, können Sie sie nicht überschreiben. Sie dürfen sie definieren, aber Ihr Eventhandler wird nicht aufgerufen, wenn der Benutzer sie eingibt.
Alternativ kann das Tastenkürzel als eine der folgenden Medientasten angegeben werden:
Definieren Sie ein einzelnes Tastenkürzel, das nur standardmäßig verwendet wird:
"commands": { "toggle-feature": { "suggested_key": { "default": "Ctrl+Shift+Y" }, "description": "Ereignis'toggle-feature' senden" } }
Definieren Sie zwei Tastenkürzel, eins mit einer plattformspezifischen Tastenkombination:
"commands": { "toggle-feature": { "suggested_key": { "default": "Alt+Shift+U", "linux": "Ctrl+Shift+U" }, "description": "Ereignis 'toggle-feature' senden" }, "do-another-thing": { "suggested_key": { "default": "Ctrl+Shift+Y" } } }
{{Compat("webextensions.manifest.commands")}}