pageAction.setIcon()

Setzt das Icon für die Page-Action.

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

Sie können mehrere Icons in verschiedenen Größen angeben, indem Sie ein Wörterbuch mit mehreren Pfaden oder ImageData-Objekten bereitstellen. Dies bedeutet, dass das Icon nicht für ein Gerät mit einer anderen 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 sowie 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, damit 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 die Größe, wie folgt:

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

Der Browser wählt das zu verwendende Bild basierend auf der Pixeldichte des Bildschirms aus. Weitere Informationen finden Sie unter Auswahl von Icons in verschiedenen Größen.

path Optional

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

Verwenden Sie ein Wörterbuchobjekt, um mehrere Icon-Dateien in verschiedenen Größen anzugeben, 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 die Größe, wie folgt:

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

Der Browser wählt das zu verwendende Bild basierend auf der Pixeldichte des Bildschirms aus. Weitere Informationen finden Sie unter Auswahl von Icons in verschiedenen Größen.

Wenn path null ist, wird das Icon der Page-Action auf das im page_action Manifest-Schlüssel angegebene Icon zurückgesetzt.

Wenn path "" ist, wird das Icon auf das globale Standard-Icon des Browsers zurückgesetzt (das heißt das Icon, das verwendet wird, wenn im page_action Manifest-Schlüssel kein Icon angegeben ist).

Wenn path nicht auf ein gültiges Icon zeigt, wird kein Icon angezeigt.

tabId

integer. Die ID des Tabs, dessen Icon Sie setzen möchten.

Rückgabewert

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

Browser-Kompatibilität

Beispiele

Setzen Sie das Icon 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

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