sidebarAction.setIcon()

Ihre Erweiterung sollte ein Icon für die Seitenleiste im sidebar_action-Manifest-Schlüssel angeben. Dies wird als "Manifest-Icon" bezeichnet.

Wenn Sie kein Icon im sidebar_action-Schlüssel angeben, erhalten Sie das Standardbrowser-Icon. Dies wird als "Standard-Icon" bezeichnet.

Wenn Sie ein neues Icon mit setIcon() festlegen und die tabId-Option einbeziehen, wird das Icon nur für den angegebenen Tab festgelegt. Dieses Icon wird als "tab-spezifisches Icon" bezeichnet.

Wenn Sie ein neues Icon mit setIcon() festlegen und die windowId-Option einbeziehen, wird das Icon nur für das angegebene Fenster festgelegt. Dieses Icon wird als "fensterspezifisches Icon" bezeichnet und erscheint in allen Tabs dieses Fensters, die kein tab-spezifisches Icon festgelegt haben.

Wenn Sie ein neues Icon mit setIcon() festlegen und sowohl die tabId- als auch die windowId-Option weglassen, wird dies als "globales Icon" festgelegt. Das globale Icon wird dann in allen Tabs erscheinen, die kein tab-spezifisches Icon gesetzt haben und deren Fenster kein fensterspezifisches Icon hat.

details

object. Ein Objekt mit den folgenden Eigenschaften:

imageData Optional

sidebarAction.ImageDataType oder object. Dies ist entweder ein einzelnes ImageData-Objekt oder ein Wörterbuch.

Verwenden Sie ein Wörterbuch, um mehrere ImageData-Objekte in verschiedenen Größen festzulegen, sodass das Icon nicht für ein Gerät mit einer anderen Pixeldichte skaliert werden muss. Wenn imageData ein Wörterbuch ist, ist der Wert jeder Eigenschaft ein ImageData-Objekt und sein Name ist seine Größe, wie hier:

js

let settingIcon = browser.sidebarAction.setIcon({
  imageData: {
    16: image16,
    32: image32,
  },
});

Der Browser wählt das Bild basierend auf der Pixeldichte des Bildschirms aus. Weitere Informationen finden Sie unter Wahl der Icon-Größen.

path Optional

string oder object. Dies ist entweder ein relativer Pfad zu einer Icon-Datei oder ein Wörterbuch.

Verwenden Sie ein Wörterbuch, um mehrere Icon-Dateien in verschiedenen Größen festzulegen, damit das Icon nicht für ein Gerät mit einer anderen Pixeldichte skaliert werden muss. Wenn path ein Wörterbuch ist, ist der Wert jeder Eigenschaft ein relativer Pfad und sein Name ist seine Größe, wie hier:

js

let settingIcon = browser.sidebarAction.setIcon({
  path: {
    16: "path/to/image16.jpg",
    32: "path/to/image32.jpg",
  },
});

Der Browser wählt das Bild basierend auf der Pixeldichte des Bildschirms aus. Weitere Informationen finden Sie unter Wahl der Icon-Größen.

Wenn path ein leerer String ist, verwendet der Browser das Standard-Icon.

Wenn path nicht leer ist, aber nicht auf eine Icon-Datei zeigt, wird das Icon ausgeblendet.

Wenn path null ist und tabId angegeben wurde, und der angegebene Tab ein tab-spezifisches Icon gesetzt hatte: dann wird das tab-spezifische Icon auf das globale Icon zurückgesetzt (falls ein globales Icon festgelegt ist) oder auf das Manifest-Icon.

Wenn path null ist und tabId weggelassen wurde und ein globales Icon gesetzt war, wird es auf das Manifest-Icon zurückgesetzt.

tabId Optional

integer. Setzt das Icon nur für den angegebenen Tab.

windowId Optional

integer. Setzt das Icon nur für das angegebene Fenster.

• Wenn sowohl windowId als auch tabId angegeben sind, schlägt die Funktion fehl und das Icon wird nicht gesetzt.
• Wenn sowohl windowId als auch tabId weggelassen werden, wird das Icon global gesetzt.

Ein Promise, das ohne Argumente erfüllt wird, sobald das Icon gesetzt wurde.

Der untenstehende Code wechselt das Seitenleisten-Icon für den aktiven Tab, wenn der Benutzer auf eine Browser-Aktion klickt:

let on = false;

function toggle(tab) {
  if (on) {
    browser.sidebarAction.setIcon({
      path: "off.svg",
      tabId: tab.id,
    });
    on = false;
  } else {
    browser.sidebarAction.setIcon({
      path: "on.svg",
      tabId: tab.id,
    });
    on = true;
  }
}

browser.browserAction.onClicked.addListener(toggle);