action.setBadgeTextColor()

Sets the text color for the browser action's badge. Tabs without a specific badge text color will inherit the global badge text color.

Note: This API is available in Manifest V3 or higher.

Syntax

browser.action.setBadgeTextColor(
  details // object
)

Parameters

details

An object with the following properties:

color

The color, specified as one of:

  • a string: any CSS <color> value, for example "red", "#FF0000", or "rgb(255,0,0)". If the string is not a valid color, the returned promise will be rejected and the text color won't be altered.
  • a action.ColorArray object.
  • null. If a tabId is specified, it removes the tab-specific badge text color so that the tab inherits the global badge text color. Otherwise it reverts the global badge text color to the default value.
tabId Optional

integer. Sets the badge text color only for the given tab. The color is reset when the user navigates this tab to a new page.

windowId Optional

integer. Sets the badge text color only for the given tab.

  • If windowId and tabId are both supplied, the function fails and the color is not set.
  • If windowId and tabId are both omitted, the global badge text color is set instead.

Examples

A badge text color that starts off as red, and turns green when the browser action is clicked:

browser.action.setBadgeText({text: "1234"});
browser.action.setBadgeTextColor({color: "red"});

browser.action.onClicked.addListener(()=> {
  browser.action.setBadgeTextColor({color: "green"});
});

Set the badge text color only for the active tab:

browser.action.setBadgeText({text: "1234"});
browser.action.setBadgeTextColor({color: "red"});

browser.action.onClicked.addListener((tab)=> {
  browser.action.setBadgeTextColor({
    color: "green",
    tabId: tab.id
  });
});

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.action API. This documentation is derived from browser_action.json in the Chromium code.