Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

browserAction.setBadgeBackgroundColor()

Sets the background color for the badge.

Syntax

chrome.browserAction.setBadgeBackgroundColor(
  details // object
)

This API is also available as browser.browserAction.setBadgeBackgroundColor().

Parameters

details
object.
color
The color, specified as one of:
tabIdOptional
integer. Sets the badge background color only for the given tab.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 No 33

Examples

Set the badge background color using a CSS keyword:

function toggleBadge(badgeText) {
  if (!badgeText) {
    chrome.browserAction.setBadgeText({text: "hi!"});
  } else {
    chrome.browserAction.setBadgeText({text: ""});
  }
}

chrome.browserAction.setBadgeBackgroundColor({color: "green"});

chrome.browserAction.onClicked.addListener(() => {
  chrome.browserAction.getBadgeText({}, toggleBadge);
});

Set the badge background color only for the active tab:

chrome.browserAction.setBadgeText({text: "hi!"});

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

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

 Contributors to this page: Makyen, chrisdavidmills, wbamberg
 Last updated by: Makyen,