browserAction.setIcon()

Définit l'icône pour l'action du navigateur.

Vous pouvez spécifier une seule icône comme chemin d'accès à un fichier ou un objet browserAction.ImageDataType .

Vous pouvez spécifier plusieurs icônes dans différentes tailles en fournissant un dictionnaire contenant plusieurs chemins ou des objets  ImageData. Cela signifie que l'icône ne doit pas être mise à l'échelle pour un périphérique avec une densité de pixels différente.

Les onglets sans icône spécifique hériteront de l'icône globale, qui par défaut est  default_icon specifié dans le manifest.

Il s'agit d'une fonction asynchrone qui renvoie une Promise.

Syntaxe

var settingIcon = browser.browserAction.setIcon(
  details         // object
)

Paramètres

details
object. Un objet contenant des propriétés imageData ou path, et éventuellement une propriété tabId .
imageDataFacultatif

browserAction.ImageDataType ou object. Il s'agit soit d'un seul objet ImageData ou un dictionnaire d'objet.

Utilisez un dictionnaire d'objet pour spécifier plusieurs objets ImageData dans différentes tailles, de sorte que l'icône ne doit pas  être mise à l'échelle pour un périphérique avec une densité de pixel différentes. Si imageData est un dictionnaire, la valeur de chaque propriété  est un objetImageData, et son nom est sa taille, comme ceci :

{
  16: image16,
  32: image32
}

Le navigateur choisira l'image à utiliser en fonction de la densité de pixels de l'écran. Voir Choix de la tailles d'icônes pour plus d'informations à ce sujet.

pathFacultatif

string or object. Il s'agit du chemin relatif d'un fichier d'icône ou d'un objet de dictionnaire. 

Utilisez un dictionnaire d'objet pour spécifier plusieurs fichiers d'icônes dans différentes tailles, de sorte que l'icône ne doit pas être mise à l'échelle pour un périphérique avec une densité de pixels différentes. Si path est un dictionnaire, la valeur de chaque propriété est un chemin relatif , et son nom est sa taille, comme ceci :

{
  16: "path/to/image16.jpg",
  32: "path/to/image32.jpg"
}

Le navigateur choisira l'image à utiliser en fonction de la densité de pixels de l'écran. Voir Choix de la tailles d'icônes pour plus d'informations à ce sujet.

tabIdFacultatif
integer. Définit l'icône uniquement pour l'onglet donné. L'icône est réinitialisée lorsque l'utilisateur navigue dans cet onglet vers une nouvelle page.
windowIdFacultatif
integer. Définit l'icône de la fenêtre donnée.
  • si windowId et tabId sont tous deux fournis, la fonction échoue et l'icône n'est pas définie.
  • si windowId et tabId sont tous les deux omis, l'icône globale est définie.

Si chaque imageData et path est un objet undefined, null ou vide :

  • si tabId est spécifié, et que l'onglet a un jeu d'icônes spécifique à l'onglet, alors l'onglet héritera de l'icône de la fenêtre à laquelle il appartient.
  • si windowId est spécifié et que la fenêtre a un jeu d'icônes spécifiques à la fenêtre, alors la fenêtre héritera de l'icône globale.
  • Sinon, l'icône globale sera réinitialisée à l'icône du manifest.

Valeur retournée

Une Promise qui sera remplie sans arguments une fois que l'icône a été définie.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
Support simple Oui1142 3 4

45

45 — 585

Non15
imageData23 Non45 Non15
The path and imageData properties of the details parameter can be set to null. Non Non59 Non Non
details.windowId Non Non62 Non Non

1. Before Chrome 23, `path` couldn't specify multiple icon files, but had to be a string specifying a single icon path.

2. This call is not persisted.

3. The imageData parameter is not accepted.

4. The path parameter is required.

5. Tab-specific icons are not cleared when a new page is loaded.

Exemples

Le code ci-dessous utilise une action du navigateur pour basculer un auditeur pour webRequest.onHeadersReceived, et utilise setIcon() pour indiquer si l'écoute est activée ou désactivée :

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);

Le code ci-dessous définit l'icône à l'aide d'un objetImageData :

function getImageData() {
  var canvas = document.createElement("canvas");
  var 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()});
});

L'extrait suivant met à jour l'icône lorsque l'utilisateur clique, mais uniquement pour l'onglet actif :

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

Example extensions

Remerciements :

Cette API est basée sur l'API Chromium chrome.browserAction. Cette documentation est dérivée de browser_action.json dans le code de Chromium code.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

Contributeurs à cette page : hellosct1
Dernière mise à jour par : hellosct1,