commands

Der Schlüssel commands ist ein Objekt, und jede Tastenkombination ist eine Eigenschaft davon. Der Name der Eigenschaft ist der Name des Tastenkürzels.

Der Wert jedes Tastenkürzels ist ein Objekt mit bis zu 2 Eigenschaften:

1. suggested_key: die Tasten-Kombination, die das Kürzel aktiviert.
2. description: eine Zeichenkette, die das Kürzel beschreibt; d.h., was es macht.

Die Eigenschaft suggested_key ist ein Objekt mit einer der folgenden Eigenschaften (alle Zeichenketten):

• "default"
• "mac"
• "linux"
• "windows"
• "chromeos"
• "android"
• "ios"

Der Wert jeder Eigenschaft ist das Tastenkürzel für den Befehl auf dieser Plattform, als Zeichenfolge, die Tasten enthält, getrennt durch "+". Der Wert für "default" wird auf allen Plattformen verwendet, die nicht explizit aufgeführt sind.

Zum Beispiel:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Alt+Shift+U",
      "linux": "Ctrl+Shift+U"
    },
    "description": "Send a 'toggle-feature' event to the extension"
  },
  "do-another-thing": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

Dieses JSON definiert 2 Kürzel:

1. "toggle-feature", aufgerufen mit Ctrl + Shift + U auf Linux, und Alt + Shift + U auf allen anderen Plattformen.
2. "do-another-thing", aufgerufen mit Ctrl + Shift + Y auf allen Plattformen.

Sie könnten dann den "toggle-feature" Befehl mit einem Code wie diesem abhören:

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

Es gibt 4 besondere Kürzel mit Standardaktionen, für die das commands.onCommand-Ereignis nicht ausgelöst wird:

• _execute_browser_action: funktioniert wie ein Klick auf eine Toolbar-Schaltfläche, die mit browserAction erstellt oder im browser_action Schlüssel in der manifest.json angegeben wurde.
• _execute_action: funktioniert wie ein Klick auf eine Toolbar-Schaltfläche, die mit action erstellt oder im action Schlüssel in der manifest.json angegeben wurde.
• _execute_page_action: funktioniert wie ein Klick auf eine Adressleisten-Schaltfläche, die mit pageAction erstellt oder im page_action Schlüssel in der manifest.json angegeben wurde.
• _execute_sidebar_action: öffnet die Sidebar der Erweiterung, die im sidebar_action manifest.json Schlüssel angegeben ist.

Die Verfügbarkeit dieser speziellen Kürzel variiert zwischen Manifest-Versionen und Browsern:

Zum Beispiel definiert dieses JSON eine Tasten-Kombination, die die Browseraktion der Erweiterung anklickt:

"commands": {
  "_execute_browser_action": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}

Es gibt zwei gültige Formate für Tastaturkürzel: als Tastenkombination oder als Medientaste.

Tastenkombinationen müssen aus 2 oder 3 Tasten bestehen:

1. Modifier (verpflichtend, außer bei Funktionstasten). Dies kann eine der folgenden sein: "Ctrl", "Alt", "Command", oder "MacCtrl".

2. Sekundärer Modifier (optional). Wenn angegeben, muss dies entweder "Shift" oder (für Firefox ≥ 63) einer von "Ctrl", "Alt", "Command", oder "MacCtrl" sein. Darf nicht der Modifier sein, der bereits als Hauptmodifier verwendet wird.

3. Taste (verpflichtend). Dies kann eine der folgenden sein:

   • die Buchstaben A – Z
   • die Zahlen 0 – 9
   • die Funktionstasten F1 – F12
   • Comma, Period, Home, End, PageUp, PageDown, Space, Insert, Delete, Up, Down, Left, Right

Die Taste wird dann als Zeichenfolge angegeben, die die Menge der Tastenwerte, in der oben genannten Reihenfolge, getrennt durch "+" enthält. Zum Beispiel "Ctrl+Shift+Z".

Wenn eine Tastenkombination bereits vom Browser (wie "Ctrl+P") oder von einem bestehenden Add-On verwendet wird, können Sie diese nicht überschreiben. Sie können es definieren, aber Ihr Ereignis-Handler wird nicht aufgerufen, wenn der Benutzer die Tastenkombination drückt.

Alternativ kann das Kürzel als eine der folgenden Medientasten angegeben werden:

• "MediaNextTrack"
• "MediaPlayPause"
• "MediaPrevTrack"
• "MediaStop"

Kürzel können über commands.update() aktualisiert werden. Benutzer können Kürzel auch über die Option "Erweiterungskürzel verwalten" unter about:addons in Firefox aktualisieren, wie in diesem Video gezeigt. In Chrome können Benutzer Kürzel unter chrome://extensions/shortcuts ändern.

Definieren Sie ein einziges Tastaturkürzel, nur mit der Standard-Tastenkombination:

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

Definieren Sie zwei Tastaturkürzel, eines mit einer plattformspezifischen Tastenkombination:

"commands": {
  "toggle-feature": {
    "suggested_key": {
      "default": "Alt+Shift+U",
      "linux": "Ctrl+Shift+U"
    },
    "description": "Send a 'toggle-feature' event"
  },
  "do-another-thing": {
    "suggested_key": {
      "default": "Ctrl+Shift+Y"
    }
  }
}