browserAction.setIcon()

details

object. Ein Objekt, das die Eigenschaft imageData oder path enthält und optional entweder oder beide der Eigenschaften tabId und windowId.

imageData Optional

browserAction.ImageDataType oder object. Dies ist entweder ein einzelnes ImageData-Objekt oder ein Wörterbuchobjekt.

Verwenden Sie ein Wörterbuchobjekt, um mehrere ImageData-Objekte in verschiedenen Größen anzugeben, sodass das Symbol 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 dessen Name ist seine Größe, wie folgt:

js

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

Der Browser wird das zu verwendende Bild abhängig von der Pixeldichte des Bildschirms wählen. Siehe Auswahl von Symbolgrößen für weitere Informationen.

path Optional

string oder object. Dies ist entweder ein relativer Pfad zu einer Symboldatei oder ein Wörterbuchobjekt.

Verwenden Sie ein Wörterbuchobjekt, um mehrere Symboldateien in verschiedenen Größen anzugeben, sodass das Symbol 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 dessen Name ist seine Größe, wie folgt:

js

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

Der Browser wird das zu verwendende Bild abhängig von der Pixeldichte des Bildschirms wählen. Siehe Auswahl von Symbolgrößen für weitere Informationen.

tabId Optional

integer. Setzt das Symbol nur für den angegebenen Tab. Das Symbol wird zurückgesetzt, wenn der Benutzer diesen Tab auf eine neue Seite navigiert.

windowId Optional

integer. Setzt das Symbol für das angegebene Fenster.

• Wenn windowId und tabId beide angegeben sind, schlägt die Funktion fehl und das Symbol wird nicht gesetzt.
• Wenn windowId und tabId beide weggelassen werden, wird das globale Symbol gesetzt.

Wenn imageData und path jeweils undefined, null oder ein leeres Objekt sind:

• Wenn tabId angegeben ist und der Tab ein tabspezifisches Symbol hat, dann wird der Tab das Symbol des Fensters erben, zu dem er gehört.
• Wenn windowId angegeben ist und das Fenster ein fensterspezifisches Symbol hat, dann wird das Fenster das globale Symbol erben.
• Andernfalls wird das globale Symbol auf das Manifestsymbol zurückgesetzt.

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

Der untenstehende Code verwendet eine Browser-Aktion, um einen Listener für webRequest.onHeadersReceived umzuschalten, und verwendet setIcon(), um anzuzeigen, ob das Zuhören aktiv ist oder nicht:

function logResponseHeaders(requestDetails) {
  console.log(requestDetails);
}

function startListening() {
  browser.webRequest.onHeadersReceived.addListener(
    logResponseHeaders,
    { urls: ["<all_urls>"] },
    ["responseHeaders"],
  );
  browser.browserAction.setIcon({ path: "icons/listening-on.svg" });
}

function stopListening() {
  browser.webRequest.onHeadersReceived.removeListener(logResponseHeaders);
  browser.browserAction.setIcon({ path: "icons/listening-off.svg" });
}

function toggleListener() {
  if (browser.webRequest.onHeadersReceived.hasListener(logResponseHeaders)) {
    stopListening();
  } else {
    startListening();
  }
}

browser.browserAction.onClicked.addListener(toggleListener);

Der folgende Code setzt das Symbol mit einem ImageData-Objekt:

function getImageData() {
  let canvas = document.createElement("canvas");
  let ctx = canvas.getContext("2d");

  ctx.fillStyle = "green";
  ctx.fillRect(10, 10, 100, 100);

  return ctx.getImageData(50, 50, 100, 100);
}

browser.browserAction.onClicked.addListener(() => {
  browser.browserAction.setIcon({ imageData: getImageData() });
});

Das folgende Snippet aktualisiert das Symbol, wenn der Benutzer darauf klickt, jedoch nur für den aktiven Tab:

browser.browserAction.onClicked.addListener((tab) => {
  browser.browserAction.setIcon({
    tabId: tab.id,
    path: "icons/updated-48.png",
  });
});

• bookmark-it