sidebar_action

Typ Object
Erforderlich Nein
Manifest-Version 2 oder höher
Beispiel
json
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "default_panel": "sidebar/sidebar.html",
  "open_at_install":true
}

Ein Seitenbereich ist ein Bereich, der auf der linken Seite des Browserfensters neben der Webseite angezeigt wird. Der Browser bietet eine Benutzeroberfläche, die es dem Benutzer ermöglicht, die aktuell verfügbaren Seitenbereiche zu sehen und einen Seitenbereich zur Anzeige auszuwählen.

Der Schlüssel sidebar_action ermöglicht es Ihnen, die Standardwerte für den Seitenbereich zu definieren. Sie können diese Eigenschaften zur Laufzeit mit der sidebarAction API ändern.

Syntax

Der sidebar_action Schlüssel ist ein Objekt, das beliebige der unten aufgeführten Eigenschaften haben kann. Die einzige erforderliche Eigenschaft ist default_panel.

Name Typ Beschreibung
browser_style
Optional
in Manifest V3. 		Boolean

Optional, voreingestellt auf:

  • true in Manifest V2 und vor Firefox 115 in Manifest V3.
  • false in Manifest V3 ab Firefox 115.

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

In Firefox kann das Stylesheet bei chrome://browser/content/extension.css oder chrome://browser/content/extension-mac.css auf macOS angesehen werden. Beim Festlegen der Abmessungen beachten Sie bitte, dass dieses Stylesheet box-sizing: border-box setzt (siehe box-sizing).

default_icon
Optional		 Object oder String

Verwenden Sie dies, um ein oder mehrere Symbole für den Seitenbereich festzulegen. Das Symbol wird in der Benutzeroberfläche des Browsers zum Öffnen und Schließen von Seitenbereichen angezeigt.

Symbole werden als URLs relativ zur manifest.json-Datei selbst angegeben.

Sie können eine einzelne Symboldatei angeben, indem Sie hier einen String angeben:

json
"default_icon": "path/to/geo.svg"

Um mehrere Symbole in verschiedenen Größen anzugeben, geben Sie hier ein Objekt an. Der Name jeder Eigenschaft ist die Höhe des Symbols in Pixeln und muss in eine Ganzzahl konvertierbar sein. Der Wert ist die URL. Zum Beispiel:

json
    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

Weitere Informationen finden Sie unter Wählen von Symbolgrößen.

Diese Eigenschaft ist optional: Wenn sie weggelassen wird, erhält der Seitenbereich kein Symbol.

default_panel String

Der Pfad zu einer HTML-Datei, die den Inhalt des Seitenbereichs angibt.

Die HTML-Datei kann CSS- und JavaScript-Dateien unter Verwendung von <link> und <script> -Elementen enthalten, genau wie eine normale Webseite.

Anders als bei einer normalen Webseite kann JavaScript, das im Bereich ausgeführt wird, auf alle WebExtension APIs zugreifen (vorausgesetzt, die Erweiterung verfügt über die entsprechenden Berechtigungen).

Diese Eigenschaft ist erforderlich.

Dies ist eine lokalisierbare Eigenschaft.

default_title
Optional		 String

Titel für den Seitenbereich. Dieser wird in der Browseroberfläche zur Auflistung und zum Öffnen von Seitenbereichen verwendet und wird oben im Seitenbereich angezeigt, wenn dieser geöffnet ist.

Diese Eigenschaft ist optional: Wenn sie weggelassen wird, ist der Titel des Seitenbereichs der Name der Erweiterung.

Dies ist eine lokalisierbare Eigenschaft.

open_at_install
Optional		 Boolean Optional, voreingestellt auf true. Bestimmt, ob der Seitenbereich bei der Installation geöffnet werden soll. Das Standardverhalten ist, den Seitenbereich zu öffnen, wenn die Installation abgeschlossen ist.

Beispiel

json
"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "My sidebar!",
  "default_panel": "sidebar.html"
}

Ein Beispiel für eine Erweiterung, die einen Seitenbereich verwendet, finden Sie unter annotate-page.

Browser-Kompatibilität

Siehe auch