browserAction.setBadgeText()

为浏览器操作设置徽章文本。徽章显示在图标上方。

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

语法

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

此 API 也称为 chrome.browserAction.setBadgeText()

参数

details

具有以下属性的对象

text

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

如果不需要徽章,请使用空字符串 - "" -。

如果指定了 tabId,则 null 将删除特定于标签的徽章文本,以便标签继承全局徽章文本。否则,它将全局徽章文本恢复为 ""

如果指定了 windowId,则 null 将删除特定于窗口的徽章文本,以便标签继承全局徽章文本。否则,它将全局徽章文本恢复为 ""

tabId 可选

integer。仅为给定的标签设置徽章文本。当用户将该标签导航到新页面时,文本将重置。

windowId 可选

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

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

浏览器兼容性

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

示例

添加徽章,指示用户点击按钮的次数

js
let clicks = 0;

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

browser.browserAction.onClicked.addListener(increment);

示例扩展

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