action.getBadgeBackgroundColor()
Gets the background color of the browser action's badge.
Note: This API is available in Manifest V3 or higher.
This is an asynchronous function that returns a Promise
.
Syntax
js
browser.action.getBadgeBackgroundColor(
details // object
)
Parameters
details
-
An object with the following properties:
tabId
Optional-
integer
. Specifies the tab to get the badge background color from. windowId
Optional-
integer
. 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 action.ColorArray
.
Examples
Log the badge's background color:
js
function onGot(color) {
console.log(color);
}
function onFailure(error) {
console.log(error);
}
browser.action.getBadgeBackgroundColor({}).then(onGot, onFailure);
Browser compatibility
BCD tables only load in the browser
Note: This API is based on Chromium's chrome.action
API. This documentation is derived from browser_action.json
in the Chromium code.