sidebarAction.setIcon()

Ihre Erweiterung sollte ein Icon für die Sidebar 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 Standard-Icon des Browsers. Dies wird als "Standard-Icon" bezeichnet.

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

Wenn Sie ein neues Icon mit setIcon() setzen und die Option windowId einfügen, wird das Icon nur für das angegebene Fenster gesetzt. Dieses Icon wird als "fenster-spezifisches Icon" bezeichnet und erscheint in allen Tabs dieses Fensters, für die kein tab-spezifisches Icon festgelegt ist.

Wenn Sie ein neues Icon mit setIcon() setzen und sowohl die Optionen tabId als auch windowId weglassen, dann wird das "globale Icon" gesetzt. Das globale Icon erscheint dann in allen Tabs, die kein tab-spezifisches Icon gesetzt haben und deren Fenster kein fenster-spezifisches 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-Objekt.

Verwenden Sie ein Wörterbuch-Objekt, um mehrere ImageData-Objekte in unterschiedlichen Größen anzugeben, damit das Icon nicht für ein Gerät mit unterschiedlicher 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 folgt:

js

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

Der Browser wählt das zu verwendende Bild je nach Pixeldichte des Bildschirms aus. Siehe Wählen von Icon-Größen für mehr Informationen dazu.

path Optional

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

Verwenden Sie ein Wörterbuch-Objekt, um mehrere Icon-Dateien in verschiedenen Größen anzugeben, damit das Icon nicht für ein Gerät mit unterschiedlicher 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 folgt:

js

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

Der Browser wählt das zu verwendende Bild je nach Pixeldichte des Bildschirms aus. Siehe Wählen von Icon-Größen für mehr Informationen dazu.

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

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

Wenn path null ist und tabId angegeben wurde und der angegebene Tab ein tab-spezifisches Icon hatte: dann wird das tab-spezifische Icon auf das globale Icon zurückgesetzt (falls ein globales Icon gesetzt ist) oder 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 folgende Code wechselt das Sidebar-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);