action.setBadgeText()

为浏览器操作设置徽章文本。徽章显示在图标的顶部。

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

没有特定徽章文本的选项卡将继承全局徽章文本,默认情况下为 ""

语法

js
browser.action.setBadgeText(
  details // object
)

此 API 也可以作为 chrome.action.setBadgeText() 使用。

参数

details

具有以下属性的对象

text

stringnull。可以传递任意数量的字符,但大约只有四个字符可以容纳在空间中。

如果您不希望有任何徽章,请使用空字符串 - ""

如果指定了 tabIdnull 将删除特定于选项卡的徽章文本,以便选项卡继承全局徽章文本。否则,它会将全局徽章文本恢复为 ""

如果指定了 windowIdnull 将删除特定于窗口的徽章文本,以便选项卡继承全局徽章文本。否则,它会将全局徽章文本恢复为 ""

tabId 可选

integer。仅为给定的选项卡设置徽章文本。当用户将此选项卡导航到新页面时,文本将被重置。

windowId 可选

integer。为给定的窗口设置徽章文本。

  • 如果同时提供 windowIdtabId,则函数将失败。
  • 如果同时省略 windowIdtabId,则设置全局徽章。

示例

添加一个徽章来指示用户点击按钮的次数

js
let clicks = 0;

function increment() {
  browser.action.setBadgeText({ text: (++clicks).toString() });
}

browser.action.onClicked.addListener(increment);

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

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