browserAction
Lesen und Ändern von Attributen und Anhören von Klicks auf die im browser_action manifest key definierte Schaltfläche der Browser-Symbolleiste.
Eine Browseraktion ist eine Schaltfläche in der Symbolleiste des Browsers.
Sie können ein Popup mit der Schaltfläche verknüpfen. Wie eine Webseite wird das Popup unter Verwendung von HTML, CSS und JavaScript angegeben. 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 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 wird 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 diesem Menü mit der menus API und dem browser_action menus.ContextType Elemente hinzufügen.
Mit der browserAction API können Sie:
browserAction.onClickedverwenden, um auf Klicks auf das Symbol zu hören.- Die Eigenschaften des Symbols – Symbol, Titel, Popup usw. – abrufen und festlegen. Sie können diese global für alle Tabs oder für einen Tab festlegen, indem Sie die Tab-ID als zusätzliches Argument übergeben.
Typen
browserAction.ColorArray-
Ein Array von vier Ganzzahlen im Bereich von 0-255, das eine RGBA-Farbe definiert.
browserAction.ImageDataType-
Pixeldaten für ein Bild. Muss ein
ImageDataObjekt sein (zum Beispiel von einem<canvas>Element).
Funktionen
browserAction.setTitle()-
Legt den Titel der Browseraktion fest. Dieser wird in einem Tooltip angezeigt.
browserAction.getTitle()-
Ruft den Titel der Browseraktion ab.
browserAction.setIcon()-
Legt das Symbol der Browseraktion fest.
browserAction.setPopup()-
Legt das HTML-Dokument fest, das als Popup geöffnet wird, wenn der Benutzer auf das Symbol der Browseraktion klickt.
browserAction.getPopup()-
Ruft das als Popup festgelegte HTML-Dokument ab.
browserAction.openPopup()-
Öffnet das Popup der Browseraktion.
browserAction.setBadgeText()-
Legt den Text des Browseraktionsabzeichens fest. Das Abzeichen wird über dem Symbol angezeigt.
browserAction.getBadgeText()-
Ruft den Text des Browseraktionsabzeichens ab.
browserAction.setBadgeBackgroundColor()-
Legt die Hintergrundfarbe des Abzeichens fest.
browserAction.getBadgeBackgroundColor()-
Ruft die Hintergrundfarbe des Abzeichens ab.
browserAction.setBadgeTextColor()-
Legt die Textfarbe des Abzeichens fest.
browserAction.getBadgeTextColor()-
Ruft die Textfarbe des Abzeichens ab.
browserAction.getUserSettings()-
Ruft die benutzerspezifischen Einstellungen für die Browseraktion ab.
browserAction.enable()-
Aktiviere die Browseraktion für einen Tab. Standardmäßig sind Browseraktionen für alle Tabs aktiviert.
browserAction.disable()-
Deaktiviert die Browseraktion für einen Tab, was bedeutet, dass sie nicht angeklickt werden kann, wenn dieser Tab aktiv ist.
browserAction.isEnabled()-
Überprüft, ob die Browseraktion aktiviert ist oder nicht.
Ereignisse
browserAction.onClicked-
Wird ausgelöst, wenn ein Browseraktionssymbol angeklickt wird. Dieses Ereignis wird nicht ausgelöst, wenn die Browseraktion ein Popup hat.
browserAction.onUserSettingsChanged-
Wird ausgelöst, wenn eine Änderung in den benutzerspezifischen Einstellungen erfolgt, die eine Erweiterung der Browseraktion beeinflusst.
Beispielerweiterungen
Browser-Kompatibilität
Hinweis:
Diese API basiert auf der Chromium chrome.browserAction API. Diese Dokumentation stammt von browser_action.json im Chromium-Code.