action.setIcon()

设置浏览器操作的图标。

注意:此 API 在清单 V3 或更高版本中可用。

您可以指定单个图标,可以是图像文件路径或 action.ImageDataType 对象。

您可以通过提供包含多个路径或 ImageData 对象的字典来指定不同尺寸的多个图标。这意味着图标不必为具有不同像素密度的设备缩放。

没有特定图标的标签将继承全局图标,默认情况下是清单中指定的 default_icon

这是一个异步函数,它返回一个 Promise

语法

js
let settingIcon = browser.action.setIcon(
  details         // object
)

参数

details

object. 包含 imageDatapath 属性的对象,以及可选的 tabIdwindowId 属性。

imageData 可选

action.ImageDataTypeobject. 这是一个单独的 ImageData 对象或字典对象。

使用字典对象在不同尺寸下指定多个 ImageData 对象,因此图标不必为具有不同像素密度的设备缩放。如果 imageData 是一个字典,则每个属性的值都是一个 ImageData 对象,其名称是其尺寸,例如

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

浏览器将根据屏幕的像素密度选择要使用的图像。有关此内容的更多信息,请参阅 选择图标尺寸

path 可选

stringobject. 这是一个指向图标文件的相对路径,或者是一个字典对象。

使用字典对象在不同尺寸下指定多个图标文件,因此图标不必为具有不同像素密度的设备缩放。如果 path 是一个字典,则每个属性的值都是一个相对路径,其名称是其尺寸,例如

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

浏览器将根据屏幕的像素密度选择要使用的图像。有关此内容的更多信息,请参阅 选择图标尺寸

tabId 可选

integer. 仅为给定的标签设置图标。当用户将此标签导航到新页面时,图标将重置。

windowId 可选

integer. 为给定的窗口设置图标。

  • 如果同时提供 windowIdtabId,则该函数将失败,图标不会设置。
  • 如果同时省略 windowIdtabId,则将设置全局图标。

如果 imageDatapath 每个都是 undefinednull 或空对象

  • 如果指定了 tabId,并且该标签已设置标签特定的图标,则该标签将继承其所属窗口的图标。
  • 如果指定了 windowId,并且该窗口已设置窗口特定的图标,则该窗口将继承全局图标。
  • 否则,全局图标将重置为清单图标。

返回值

一个 Promise,它将在图标设置完毕后以无参数的形式完成。

示例

以下代码使用浏览器操作来切换对 webRequest.onHeadersReceived 的侦听器,并使用 setIcon() 来指示侦听是否处于开启或关闭状态

js
function logResponseHeaders(requestDetails) {
  console.log(requestDetails);
}

function startListening() {
  browser.webRequest.onHeadersReceived.addListener(
    logResponseHeaders,
    { urls: ["<all_urls>"] },
    ["responseHeaders"],
  );
  browser.action.setIcon({ path: "icons/listening-on.svg" });
}

function stopListening() {
  browser.webRequest.onHeadersReceived.removeListener(logResponseHeaders);
  browser.action.setIcon({ path: "icons/listening-off.svg" });
}

function toggleListener() {
  if (browser.webRequest.onHeadersReceived.hasListener(logResponseHeaders)) {
    stopListening();
  } else {
    startListening();
  }
}

browser.action.onClicked.addListener(toggleListener);

以下代码使用 ImageData 对象设置图标

js
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.action.onClicked.addListener(() => {
  browser.action.setIcon({ imageData: getImageData() });
});

以下代码段在用户单击图标时更新图标,但仅适用于活动标签

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

浏览器兼容性

BCD 表仅在浏览器中加载

注意:此 API 基于 Chromium 的 chrome.action API。此文档源自 Chromium 代码中的 browser_action.json