sidebar_action

Typ Object
Verpflichtend 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
}

Eine Sidebar 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 derzeit verfügbaren Sidebars zu sehen und eine Sidebar zur Anzeige auszuwählen.

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

Syntax

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

Name Typ Beschreibung
browser_style
Optional
in Manifest V3.		 Boolean

Optional, standardmäßig:

  • 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: nicht unterstützt in Manifest V3 ab Firefox 118. 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. Beim Festlegen von Dimensionen beachten Sie, dass dieses Stylesheet box-sizing: border-box setzt (siehe box-sizing).

default_icon
Optional		 Object oder String

Damit können Sie eines oder mehrere Icons für die Sidebar angeben. Das Icon wird in der Benutzeroberfläche des Browsers zum Öffnen und Schließen von Sidebars angezeigt.

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

Sie können eine einzelne Icon-Datei angeben, indem Sie hier eine Zeichenkette angeben:

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

Um mehrere Icons in verschiedenen Größen anzugeben, geben Sie hier ein Objekt an. Der Name jeder Eigenschaft ist die Höhe des Icons in Pixel, und muss in einen Integer umwandelbar sein. Der Wert ist die URL. Zum Beispiel:

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

Siehe Auswahl der Icon-Größen für weitere Hinweise dazu.

Diese Eigenschaft ist optional: wenn sie weggelassen wird, erhält die Sidebar kein Icon.
default_panel String

Der Pfad zu einer HTML-Datei, die den Inhalt der Sidebar definiert.

Die HTML-Datei kann CSS- und JavaScript-Dateien mit <link> und <script> Elementen einbinden, genau wie eine normale Webseite.

Im Gegensatz zu einer normalen Webseite kann JavaScript, das im Panel ausgeführt wird, auf alle WebExtension-APIs zugreifen (natürlich vorausgesetzt, die Erweiterung hat die entsprechenden Berechtigungen).

Diese Eigenschaft ist verpflichtend.

Dies ist eine lokalisierbare Eigenschaft.

default_title
Optional		 String

Titel für die Sidebar. Dieser wird in der Benutzeroberfläche des Browsers zur Auflistung und zum Öffnen von Sidebars verwendet und wird oben in der Sidebar angezeigt, wenn diese geöffnet ist.

Diese Eigenschaft ist optional: wenn sie weggelassen wird, ist der Titel der Sidebar der Name der Erweiterung.

Dies ist eine lokalisierbare Eigenschaft.

open_at_install
Optional		 Boolean Optional, standardmäßig true. Bestimmt, ob die Sidebar bei der Installation geöffnet werden soll. Das Standardverhalten ist, die Sidebar zu öffnen, wenn die Installation abgeschlossen ist.

Beispiel

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

Für ein einfaches Beispiel einer Erweiterung, die eine Sidebar verwendet, siehe annotate-page.

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch