pageAction.setIcon()

Setzt das Icon für die Seitenaktion.

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 und eine tabId Eigenschaft enthält.

imageData Optional

pageAction.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 verschiedenen Größen anzugeben, 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, so:

js
let settingIcon = browser.action.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 der Icon-Größen.

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

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 basierend auf der Pixeldichte des Bildschirms aus. Weitere Informationen finden Sie unter Auswahl der Icon-Größen.

Wenn path null ist, wird das Icon der Seitenaktion auf das Icon zurückgesetzt, das im page_action Manifest-Schlüssel angegeben wurde.

Wenn path "" ist, wird das Icon auf das globale Standardicon des Browsers zurückgesetzt (das heißt, das Icon, das verwendet wird, wenn kein Icon im page_action Manifest-Schlüssel 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

BCD tables only load in the browser

Beispiele

Setzen Sie das Icon für die Seitenaktion, wenn der Nutzer darauf klickt:

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

Beispiel-Erweiterungen

Hinweis: Diese API basiert auf Chromiums chrome.pageAction API. Diese Dokumentation stammt aus page_action.json im Chromium-Code.