browserAction

Lesen und Ändern von Attributen sowie Reagieren auf Klicks auf die Schaltfläche in der Browser-Symbolleiste, die mit dem Manifest-Key browser_action definiert ist.

Eine Browser-Aktion ist eine Schaltfläche in der Symbolleiste des Browsers.

Sie können ein Popup mit der Schaltfläche verknüpfen. Wie bei einer Webseite wird das Popup mithilfe von HTML, CSS und JavaScript spezifiziert. JavaScript, das im Popup ausgeführt wird, hat Zugriff auf die gleichen WebExtension-APIs wie Ihre Hintergrundskripte, jedoch ist der globale Kontext das Popup und nicht die aktuell 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.

Die Schaltfläche verfügt auch über ein Kontextmenü, und Sie können mit der menus API Elemente zu diesem Menü mit dem browser_action menus.ContextType hinzufügen.

Mit der browserAction API können Sie:

browserAction.onClicked verwenden, um Klicks auf das Symbol zu überwachen.
Die Eigenschaften des Symbols — Symbol, Titel, Popup usw. — abrufen und festlegen. Sie können diese global für alle Tabs oder für einen bestimmten Tab festlegen, indem Sie die Tab-ID als zusätzliches Argument übergeben.

Typen

browserAction.ColorArray: Ein Array von vier Ganzzahlen im Bereich 0-255, die eine RGBA-Farbe definieren.
browserAction.ImageDataType: Pixeldaten für ein Bild. Muss ein ImageData Objekt sein (zum Beispiel von einem <canvas> Element).

Funktionen

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

Ereignisse

browserAction.onClicked: Wird ausgelöst, wenn ein Browser-Aktionssymbol 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

Beispielerweiterungen

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