browserAction.getBadgeBackgroundColor()

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.

tabIdOptional

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

windowIdOptional

integer. Specifies the window from which to get the badge background color.

• If windowId and tabId are both supplied, the function fails.
• If windowId and tabId 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

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);