pageAction.setIcon()

Legt das Symbol für die Page Action fest.

Sie können ein einzelnes Symbol entweder als Pfad zu einer Bilddatei oder als ein pageAction.ImageDataType-Objekt angeben.

Sie können multiple Symbole in verschiedenen Größen angeben, indem Sie ein Wörterbuch verwenden, das mehrere Pfade oder ImageData-Objekte enthält. Dies bedeutet, dass das Symbol nicht für ein Gerät mit unterschiedlicher Pixeldichte skaliert werden muss.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

js
let settingIcon = browser.pageAction.setIcon(
  details         // object
)

Parameter

details

object. Ein Objekt, das entweder imageData- oder path-Eigenschaften und eine tabId-Eigenschaft enthält.

imageData Optional

pageAction.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 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, so:

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

Der Browser wählt das Bild aus, das je nach Pixeldichte des Bildschirms verwendet wird. Weitere Informationen dazu finden Sie unter Auswahl von Symbolgrößen.

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 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, so:

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

Der Browser wählt das Bild aus, das je nach Pixeldichte des Bildschirms verwendet wird. Weitere Informationen dazu finden Sie unter Auswahl von Symbolgrößen.

Wenn path null ist, wird das Symbol der Page Action auf das Symbol zurückgesetzt, das im page_action-Manifesteintrag angegeben wurde.

Wenn path "" ist, wird das Symbol auf das globale Standardsymbol des Browsers zurückgesetzt (d.h. das Symbol, das verwendet wird, wenn im page_action-Manifesteintrag kein Symbol angegeben wurde).

Wenn path nicht auf ein gültiges Symbol verweist, wird kein Symbol angezeigt.

tabId

integer. Die ID des Tabs, dessen Symbol Sie festlegen möchten.

Rückgabewert

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

Beispiele

Setzen Sie das Symbol für die Page Action, wenn der Benutzer darauf klickt:

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

Beispielerweiterungen

Browser-Kompatibilität

Hinweis: Diese API basiert auf der chrome.pageAction-API von Chromium. Diese Dokumentation basiert auf page_action.json im Chromium-Code.