action

Lesen und Ändern von Attributen und Abhören von Klicks auf den Browsersymbolleisten-Button, der mit dem action-Manifest-Schlüssel definiert ist.

Hinweis: Diese API ist in Manifest V3 oder höher verfügbar. Sie ersetzt die Manifest V2 APIs browserAction und, in Chrome und Safari, pageAction.

Eine browser action ist ein Button in der Symbolleiste des Browsers.

Sie können ein Popup mit dem Button verknüpfen. Ähnlich wie eine Webseite wird das Popup mit HTML, CSS und JavaScript spezifiziert. JavaScript, das im Popup ausgeführt wird, hat Zugriff auf dieselben WebExtension-APIs wie Ihre Hintergrundskripte, aber sein globaler Kontext ist das Popup, nicht die derzeit im Browser angezeigte Seite. Um Webseiten zu beeinflussen, müssen Sie über Nachrichten mit ihnen kommunizieren.

Wenn Sie ein Popup angeben, wird es angezeigt und der Inhalt geladen, wenn der Benutzer auf das Symbol klickt. Wenn Sie kein Popup angeben, wird ein Ereignis an Ihre Erweiterung gesendet, wenn der Benutzer auf das Symbol klickt.

Der Button verfügt auch über ein Kontextmenü, und Sie können diesem Menü Elemente mit der menus API und dem action menus.ContextType hinzufügen.

Mit der action API können Sie:

action.onClicked verwenden, um Klicks auf das Symbol zu hören.
die Eigenschaften des Symbols abrufen und setzen — Symbol, Titel, Popup und so weiter. Diese können global über alle Tabs oder für einen Tab durch Übergeben der Tab-ID als zusätzliches Argument abgerufen und gesetzt werden.

Typen

action.ColorArray: Ein Array von vier Ganzzahlen im Bereich 0-255, das eine RGBA-Farbe definiert.
action.ImageDataType: Pixel-Daten für ein Bild. Muss ein ImageData-Objekt sein (zum Beispiel aus einem <canvas> Element).

Funktionen

action.setTitle(): Setzt den Titel der Browser-Aktion. Dieser wird in einem Tooltip angezeigt.
action.getTitle(): Ruft den Titel der Browser-Aktion ab.
action.setIcon(): Setzt das Symbol der Browser-Aktion.
action.setPopup(): Setzt das HTML-Dokument, das als Popup geöffnet werden soll, wenn der Benutzer auf das Symbol der Browser-Aktion klickt.
action.getPopup(): Ruft das HTML-Dokument ab, das als Popup der Browser-Aktion festgelegt wurde.
action.openPopup(): Öffnet das Popup der Browser-Aktion.
action.setBadgeText(): Setzt den Text des Badges der Browser-Aktion. Der Badge wird über dem Symbol angezeigt.
action.getBadgeText(): Ruft den Text des Badges der Browser-Aktion ab.
action.setBadgeBackgroundColor(): Setzt die Hintergrundfarbe des Badges.
action.getBadgeBackgroundColor(): Ruft die Hintergrundfarbe des Badges ab.
action.setBadgeTextColor(): Setzt die Textfarbe des Badges.
action.getBadgeTextColor(): Ruft die Textfarbe des Badges ab.
action.getUserSettings(): Ruft die benutzerspezifischen Einstellungen für die Browser-Aktion ab.
action.enable(): Aktiviert die Browser-Aktion für einen Tab. Standardmäßig sind Browser-Aktionen für alle Tabs aktiviert.
action.disable(): Deaktiviert die Browser-Aktion für einen Tab, was bedeutet, dass sie nicht angeklickt werden kann, wenn dieser Tab aktiv ist.
action.isEnabled(): Überprüft, ob die Browser-Aktion aktiviert ist oder nicht.

Ereignisse

action.onClicked: Wird ausgelöst, wenn ein Browser-Aktions-Symbol angeklickt wird. Dieses Ereignis wird nicht ausgelöst, wenn die Browser-Aktion ein Popup hat.

Browser-Kompatibilität

BCD tables only load in the browser

Hinweis: Diese API basiert auf der chrome.action API von Chromium. Diese Dokumentation ist abgeleitet von action.json im Chromium-Code.