browserAction.getBadgeTextColor()

Gets the text color for the browser action's badge.

From Firefox 63, unless the badge text color is explicitly set using browserAction.setBadgeTextColor(), then the badge text color will be automatically set to black or white so as to maximize contrast with the specified badge background color. For example, if you set the badge background color to white, the default badge text color will be set to black, and vice versa.

Other browsers always use a white text color.

This is an asynchronous function that returns a Promise.

Syntax

browser.browserAction.getBadgeTextColor(
  details // object
)

Parameters

details
object.
tabIdOptional
integer. Specifies the tab to get the badge text color from.
windowIdOptional
integer. Specifies the window from which to get the badge text color.
  • If windowId and tabId are both supplied, the function fails.
  • If windowId and tabId are both omitted, the global badge text 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
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome No support NoEdge No support NoFirefox Full support 63Opera No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support

Examples

Log the badge's text color:

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

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

browser.browserAction.getBadgeTextColor({}).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.

Document Tags and Contributors

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