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
.tabId
Optionalinteger
. Specifies the tab to get the badge background color from.windowId
Optionalinteger
. Specifies the window from which to get the badge background color.
- If
windowId
andtabId
are both supplied, the function fails. - If
windowId
andtabId
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
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
Log the badge's background color:
function onGot(color) {
console.log(color);
}
function onFailure(error) {
console.log(error);
}
browser.browserAction.getBadgeBackgroundColor({}).then(onGot, onFailure);
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.