Gets the background color of the browser action's badge.

This is an asynchronous function that returns a Promise.


  details // object



An object with the following properties:

tabId Optional

integer. Specifies the tab to get the badge background color from.

windowId Optional

integer. Specifies the window from which to get the badge background color.

  • If windowId and tabId are both supplied, the function fails.
  • If windowId and tabId are both omitted, the global badge background color is returned.

Return value

A Promise that will be fulfilled with the retrieved color as a browserAction.ColorArray.

Browser compatibility

BCD tables only load in the browser


Log the badge's background color:

function onGot(color) {

function onFailure(error) {

browser.browserAction.getBadgeBackgroundColor({}).then(onGot, onFailure);

Note: 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.