1. Mozilla
  2. Add-ons
  3. Browser extensions
  4. JavaScript APIs
  5. action
  6. action.getBadgeTextColor()

action.getBadgeTextColor()

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

Note: This API is available in Manifest V3 or higher.

In Firefox, unless the badge text color is explicitly set using action.setBadgeTextColor(), the badge text color is 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 is set to black, and vice versa.

Other browsers always use a white text color.

This is an asynchronous function that returns a Promise.

Syntax

js
browser.action.getBadgeTextColor(
  details // object
)

Parameters

details

object.

tabId Optional

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

windowId Optional

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 action.ColorArray.

Examples

Log the badge's text color:

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

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

browser.action.getBadgeTextColor({}).then(onGot, onFailure);

Browser compatibility

Note: This API is based on Chromium's chrome.action API. This documentation is derived from browser_action.json in the Chromium code.

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content