pageAction.setIcon()
Setzt das Icon für die Page Action.
Sie können ein einzelnes Icon entweder als Pfad zu einer Bilddatei oder als ein 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
let settingIcon = browser.pageAction.setIcon(
details // object
)
Parameter
details
-
object
. Ein Objekt, das entwederimageData
- oderpath
-Eigenschaften und einetabId
-Eigenschaft enthält.imageData
Optional-
oderpageAction.ImageDataType
object
. Dies ist entweder ein einzelnesImageData
-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. WennimageData
ein Wörterbuch ist, ist der Wert jeder Eigenschaft einImageData
-Objekt und sein Name ist seine Größe, wie folgt:jslet settingIcon = browser.pageAction.setIcon({ imageData: { 16: image16, 32: image32, }, });
Der Browser wählt das zu verwendende Bild in Abhängigkeit von der Pixeldichte des Bildschirms. Siehe Auswahl von Icon-Größen für weitere Informationen.
path
Optional-
string
oderobject
. 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 seine Größe, wie folgt:jslet settingIcon = browser.pageAction.setIcon({ path: { 16: "path/to/image16.jpg", 32: "path/to/image32.jpg", }, });
Der Browser wählt das zu verwendende Bild in Abhängigkeit von der Pixeldichte des Bildschirms. Siehe Auswahl von Icon-Größen für weitere Informationen.
Wenn
path
null
ist, wird das Icon der Page Action auf das impage_action
Manifest-Schlüssel angegebene Icon zurückgesetzt.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 impage_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 der Page Action, wenn der Benutzer darauf klickt:
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 basiert auf page_action.json
im Chromium-Quellcode.