sidebarAction

Ruft Eigenschaften einer Erweiterungs-Sidebar ab und legt diese fest.

Eine Sidebar ist ein Bereich, der auf der linken oder rechten Seite einer Webseite angezeigt wird. Der Browser stellt eine Benutzeroberfläche bereit, die es dem Benutzer ermöglicht, die verfügbaren Sidebars anzuzeigen und eine zur Anzeige auszuwählen. Eine Erweiterung definiert Sidebars mithilfe des [sidebar_action](/de/docs/Mozilla/Add-ons/WebExtensions/manifest.json/sidebar_action)-Schlüssel in der manifest.json-Datei. Die Erweiterung kann dann die Eigenschaften der Sidebar mithilfe dieser API abrufen und festlegen.

Hinweis: Chrome bietet Unterstützung für Sidebars über die sidePanel API. Diese API ist nicht mit sidebarAction kompatibel.

Die sidebarAction API basiert auf Operas sidebarAction API und ist eng am browserAction API ausgerichtet. Allerdings hat Firefox setBadgeText(), getBadgeText(), setBadgeBackgroundColor(), getBadgeBackgroundColor(), onFocus und onBlur nicht implementiert.

Typen

sidebarAction.ImageDataType

Pixel-Daten für ein Bild. Muss ein ImageData-Objekt sein (zum Beispiel von einem <canvas>-Element).

Funktionen

sidebarAction.close()

Schließt die Sidebar.

sidebarAction.getPanel()

Ruft das Panel der Sidebar ab.

sidebarAction.getTitle()

Ruft den Titel der Sidebar ab.

sidebarAction.isOpen()

Prüft, ob die Sidebar geöffnet ist.

sidebarAction.open()

Öffnet die Sidebar.

sidebarAction.setIcon()

Legt das Symbol der Sidebar fest.

sidebarAction.setPanel()

Legt das Panel der Sidebar fest.

sidebarAction.setTitle()

Legt den Titel der Sidebar fest. Dieser Titel wird in jeder Benutzeroberfläche angezeigt, die der Browser zur Auflistung von Sidebars bereitstellt, wie z. B. ein Menü.

sidebarAction.toggle()

Schaltet die Sichtbarkeit der Sidebar um.

Beispiele

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
sidebarAction
ImageDataType
close
getBadgeBackgroundColor
getBadgeText
getPanel
getTitle
isOpen
onBlur
onFocus
open
setBadgeBackgroundColor
setBadgeText
setIcon
The path and imageData properties of the details parameter can be set to null.
setPanel
The panel property of the details parameter can be set to null.
setTitle
The title property of the details parameter can be set to null.
toggle

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support