browserAction.getBadgeBackgroundColor()

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

This is an asynchronous function that returns a Promise.

Syntax

browser.browserAction.getBadgeBackgroundColor(
  details // object
)

Parameters

details
object.
tabIdOptional
integer. Specifies the tab to get the badge background color from. If no tab is specified, the non-tab-specific badge background color is returned.

Return value

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

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYesYes45NoYes

Examples

Log the badge's background color:

function onGot(color) {
  console.log(color);
}
function onFailure(error) {
  console.log(error);
}
browser.browserAction.getBadgeBackgroundColor({}).then(onGot, onFail);

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: michael-zapata, Makyen, chrisdavidmills, wbamberg
 Last updated by: michael-zapata,