Add-ons

browserAction.setBadgeBackgroundColor()

Sets the background color for the badge. Tabs without a specific badge background color will inherit the global badge background color, which defaults to [217, 0, 0, 255] in Firefox.

Syntax

browser.browserAction.setBadgeBackgroundColor(
  details // object
)

Parameters

details
object.
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 background color won't be altered.
  • a browserAction.ColorArray object.
  • null. If a tabId is specified, it removes the tab-specific badge background color so that the tab inherits the global badge background color. Otherwise it reverts the global badge background color to the default value.
tabIdOptional
integer. Sets the badge background color only for the given tab. If omitted, the global badge background color is set instead.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes Yes45 No Yes
The color property of the details parameter can be set to null. No No59 No No

The default color in Firefox is: [217, 0, 0, 255].

Examples

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

browser.browserAction.setBadgeText({text: "1234"});
browser.browserAction.setBadgeBackgroundColor({color: "red"});

browser.browserAction.onClicked.addListener(()=> {
  browser.browserAction.setBadgeBackgroundColor({color: "green"});
});

Set the badge background color only for the active tab:

browser.browserAction.setBadgeText({text: "1234"});
browser.browserAction.setBadgeBackgroundColor({color: "red"});

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

Example extensions

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Last updated by: Loirooriol,