browserAction.setIcon()
Setzt das Icon für die Browser-Aktion.
Sie können ein einzelnes Icon entweder als Pfad zu einer Bilddatei oder als browserAction.ImageDataType
-Objekt angeben.
Sie können mehrere Icons in verschiedenen Größen angeben, indem Sie ein Wörterbuch bereitstellen, das mehrere Pfade oder ImageData
-Objekte enthält. Das bedeutet, dass das Icon nicht für ein Gerät mit einer anderen Pixeldichte skaliert werden muss.
Tabs ohne spezifisches Icon erben das globale Icon, welches standardmäßig auf das default_icon
gesetzt ist, das im Manifest angegeben ist.
Dies ist eine asynchrone Funktion, die ein Promise
zurückgibt.
Syntax
let settingIcon = browser.browserAction.setIcon(
details // object
)
Parameter
details
-
object
. Ein Objekt, das dieimageData
- oderpath
-Eigenschaft und optional entweder oder beide dertabId
- undwindowId
-Eigenschaften enthält.imageData
Optional-
oderbrowserAction.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, sodass 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 der Name ist seine Größe, wie folgt:jslet settingIcon = browser.action.setIcon({ imageData: { 16: image16, 32: image32, }, });
Der Browser wählt das zu verwendende Bild je nach Pixeldichte des Bildschirms aus. Siehe Auswahl von Icon-Größen für weitere Informationen dazu.
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, 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 der Name ist seine Größe, wie folgt:jslet settingIcon = browser.action.setIcon({ path: { 16: "path/to/image16.jpg", 32: "path/to/image32.jpg", }, });
Der Browser wählt das zu verwendende Bild je nach Pixeldichte des Bildschirms aus. Siehe Auswahl von Icon-Größen für weitere Informationen dazu.
tabId
Optional-
integer
. Setzt das Icon nur für den angegebenen Tab. Das Icon wird zurückgesetzt, wenn der Benutzer diesen Tab auf eine neue Seite navigiert. windowId
Optional-
integer
. Setzt das Icon für das angegebene Fenster.
- Wenn
windowId
undtabId
beide angegeben sind, schlägt die Funktion fehl und das Icon wird nicht gesetzt. - Wenn
windowId
undtabId
beide weggelassen werden, wird das globale Icon gesetzt.
Wenn jede von imageData
und path
eine der undefined
, null
oder leeren Objekt ist:
- Wenn
tabId
angegeben ist und der Tab ein tab-spezifisches Icon gesetzt hat, dann erbt der Tab das Icon vom Fenster, zu dem es gehört. - Wenn
windowId
angegeben ist und das Fenster ein fensterspezifisches Icon gesetzt hat, dann erbt das Fenster das globale Icon. - Andernfalls wird das globale Icon auf das Manifest-Icon zurückgesetzt.
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
Der untenstehende Code verwendet eine Browser-Aktion, um einen Listener für webRequest.onHeadersReceived
zu toggeln, und verwendet setIcon()
, um anzuzeigen, ob das Lauschen ein- oder ausgeschaltet ist:
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 untenstehende Code setzt das Icon unter Verwendung eines ImageData
-Objekts:
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() });
});
Der folgende Codeausschnitt aktualisiert das Icon, 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",
});
});
Beispielerweiterungen
Hinweis:
Diese API basiert auf der Chromium-API chrome.browserAction
. Diese Dokumentation ist von browser_action.json
im Chromium-Code abgeleitet.