browserAction.getBadgeText()

Gets the browser action's badge text.

This is an asynchronous function that returns a Promise.

Syntax

var gettingText = browser.browserAction.getBadgeText(
  details               // object
)

Parameters

details
object.
tabIdOptional
integer. Specifies the tab from which to get the badge text.
windowIdOptional
integer. Specifies the window from which to get the badge text.
  • If windowId and tabId are both supplied, the function fails.
  • If windowId and tabId are both omitted, the global badge text is returned.

Return value

A Promise that will be fulfilled with a string containing the badge text.

Browser compatibility

Report problems with this compatibility data on GitHub
webextensions-desktopwebextensions-mobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
getBadgeText

Legend

Full support
Full support

Examples

Log the badge text:

function gotBadgeText(text) {
  console.log(text);
}

var gettingBadgeText = browser.browserAction.getBadgeText({});
gettingBadgeText.then(gotBadgeText);

Acknowledgements

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.