Sets the text color for the browser action's badge. Tabs without a specific badge text color will inherit the global badge text color.
Syntax
browser.browserAction.setBadgeTextColor(
details // object
)
Parameters
details
object
.color
- The color, specified as one of:
-
- a string: any CSS <color> value, for example
"red"
,"#FF0000"
, or"rgb(255,0,0)"
. If the string is not a valid color, the returned promise will be rejected and the text color won't be altered. - a
object.browserAction.ColorArray
null
. If atabId
is specified, it removes the tab-specific badge text color so that the tab inherits the global badge text color. Otherwise it reverts the global badge text color to the default value.
- a string: any CSS <color> value, for example
tabId
Optionalinteger
. Sets the badge text color only for the given tab. The color is reset when the user navigates this tab to a new page.windowId
Optionalinteger
. Sets the badge text color only for the given tab.
- If
windowId
andtabId
are both supplied, the function fails and the color is not set. - If
windowId
andtabId
are both omitted, the global badge text color is set instead.
Browser compatibility
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
A badge text color that starts off as red, and turns green when the browser action is clicked:
browser.browserAction.setBadgeText({text: "1234"});
browser.browserAction.setBadgeTextColor({color: "red"});
browser.browserAction.onClicked.addListener(()=> {
browser.browserAction.setBadgeTextColor({color: "green"});
});
Set the badge text color only for the active tab:
browser.browserAction.setBadgeText({text: "1234"});
browser.browserAction.setBadgeTextColor({color: "red"});
browser.browserAction.onClicked.addListener((tab)=> {
browser.browserAction.setBadgeTextColor({
color: "green",
tabId: tab.id
});
});
Acknowledgements
This API is based on Chromium's chrome.browserAction
API. This documentation is derived from browser_action.json
in the Chromium code.