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.
windowIdOptional
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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
getBadgeBackgroundColorChrome Full support YesEdge Full support 14Firefox Full support 45Opera Full support YesSafari Partial support 14
Notes
Partial support 14
Notes
Notes Always returns a red ColorArray.
Firefox Android Full support 79
details.windowIdChrome No support NoEdge No support NoFirefox Full support 62Opera No support NoSafari No support NoFirefox Android No support No

Legend

Full support  
Full support
Partial support  
Partial support
No support  
No support
See implementation notes.
See implementation notes.

Examples

Log the badge's background color:

function onGot(color) {
  console.log(color);
}

function onFailure(error) {
  console.log(error);
}

browser.browserAction.getBadgeBackgroundColor({}).then(onGot, onFailure);
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.