page_action

Art Object
Erforderlich Nein
Manifest-Version 2 oder höher
Beispiel
json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  },
  "default_title": "Whereami?",
  "default_popup": "popup/geo.html"
}

Eine Seitenaktion ist ein Symbol, das Ihre Erweiterung in der URL-Leiste des Browsers hinzufügt.

Ihre Erweiterung kann optional auch ein zugehöriges Popup bereitstellen, dessen Inhalt mit HTML, CSS und JavaScript spezifiziert wird.

Sie müssen diesen Schlüssel angeben, um eine Seitenaktion in Ihre Erweiterung einzubinden. Wenn angegeben, können Sie den Button programmatisch mit der pageAction API manipulieren.

Wenn Sie ein Popup bereitstellen, wird es geöffnet, wenn der Benutzer auf das Symbol klickt, und Ihr JavaScript, das im Popup läuft, kann mit der Benutzerinteraktion umgehen. Wenn Sie kein Popup bereitstellen, wird beim Klicken des Symbols ein Klicken-Ereignis an die Hintergrundskripte Ihrer Erweiterung gesendet.

Seitenaktionen sind ähnlich wie Browser-Aktionen, außer dass sie mit bestimmten Webseiten anstatt mit dem gesamten Browser verbunden sind. Wenn eine Aktion nur auf bestimmten Seiten relevant ist, sollten Sie eine Seitenaktion verwenden und sie nur auf relevanten Seiten anzeigen. Wenn eine Aktion für alle Seiten oder für den Browser selbst relevant ist, verwenden Sie eine Browser-Aktion.

Während Browser-Aktionen standardmäßig angezeigt werden, sind Seitenaktionen standardmäßig verborgen. Sie können für einen bestimmten Tab angezeigt werden, indem Sie pageAction.show() aufrufen und die id des Tabs übergeben. Sie können dieses Standardverhalten auch mit der Eigenschaft show_matches ändern.

Syntax

Der page_action Schlüssel ist ein Objekt, das eine von drei Eigenschaften haben kann, alle optional:

Name Art Beschreibung
browser_style
Optional
in Manifest V3.		 Boolean

Optional. Standardwert ist false.

Setzen Sie browser_style nicht auf true: Es wird in Manifest V3 ab Firefox 118 nicht unterstützt. Siehe Manifest V3 Migration für browser_style.

In Firefox kann das Stylesheet unter chrome://browser/content/extension.css oder chrome://browser/content/extension-mac.css auf macOS eingesehen werden.

Die latest-download Beispiel-Erweiterung verwendet browser_style in ihrem Popup.

default_icon Object oder String

Verwenden Sie dies, um ein Symbol für die Aktion zu spezifizieren.

Es wird empfohlen, hier zwei Symbole anzugeben (19×19 Pixel und 38×38 Pixel), und sie in einem Objekt mit den Eigenschaften "19" und "38" wie folgt zu spezifizieren:

json
    "default_icon": {
      "19": "geo-19.png",
      "38": "geo-38.png"
    }

Wenn Sie dies tun, wählt der Browser die richtige Symbolgröße für die Pixeldichte des Bildschirms aus.

Sie können hier auch nur einen String angeben:

json
"default_icon": "geo.png"

Wenn Sie dies tun, wird das Symbol zur Anpassung an die Symbolleiste skaliert und kann unscharf erscheinen.

default_popup String

Der Pfad zu einer HTML-Datei, die die Spezifikation des Popups enthält.

Die HTML-Datei kann CSS und JavaScript-Dateien mit Hilfe von <link> und <script> -Elementen einbinden, genau wie eine normale Webseite. Verwenden Sie jedoch kein <script> mit eingebettetem Code, da Sie einen Content Violation Policy Fehler erhalten. Stattdessen muss <script> das src Attribut verwenden, um eine separate Skriptdatei zu laden.

Anders als bei einer normalen Webseite kann JavaScript, das im Popup läuft, auf alle WebExtension APIs zugreifen (vorausgesetzt, die Erweiterung hat die entsprechenden Berechtigungen).

Dies ist eine lokalisierbare Eigenschaft.

default_title String

Tooltip für das Symbol, das angezeigt wird, wenn der Benutzer mit der Maus darüber fährt.

Dies ist eine lokalisierbare Eigenschaft.

hide_matches Array von Match Pattern außer <all_urls>

Verbirgt die Seitenaktion standardmäßig für Seiten, deren URLs mit einem der angegebenen Suchmuster übereinstimmen.

Beachten Sie, dass Seitenaktionen standardmäßig immer verborgen sind, es sei denn, show_matches wird angegeben. Daher macht es nur Sinn, diese Eigenschaft anzugeben, wenn auch show_matches angegeben wird, und überschreibt die Muster in show_matches.

Zum Beispiel kann ein Wert so aussehen:

json
"page_action": {
  "show_matches": ["https://*.mozilla.org/*"],
  "hide_matches": ["https://developer.mozilla.org/*"]
}

Dies zeigt die Seitenaktion standardmäßig für alle HTTPS-URLs unter dem "mozilla.org" Domainnamen an, außer für Seiten unter "developer.mozilla.org".

show_matches Array von Match Pattern

Zeigt die Seitenaktion standardmäßig für Seiten an, deren URLs mit einem der angegebenen Muster übereinstimmen.

Siehe auch hide_matches.
pinned Boolean

Optional. Standardwert ist true.

Steuert, ob die Seitenaktion standardmäßig in der Adressleiste angezeigt werden sollte, wenn der Benutzer die Erweiterung installiert. Diese Eigenschaft wird seit Firefox 89 nicht mehr unterstützt.

Beispiel

json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  }
}

Eine Seitenaktion mit nur einem Symbol, angegeben in 2 verschiedenen Größen. Die Hintergrundskripte der Erweiterung können Klickereignisse empfangen, wenn der Benutzer auf das Symbol klickt, mit Code wie diesem:

js
browser.pageAction.onClicked.addListener(handleClick);
json
"page_action": {
  "default_icon": {
    "19": "button/geo-19.png",
    "38": "button/geo-38.png"
  },
  "default_title": "Whereami?",
  "default_popup": "popup/geo.html"
}

Eine Seitenaktion mit einem Symbol, einem Titel und einem Popup. Das Popup wird angezeigt, wenn der Benutzer auf das Symbol klickt.

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch