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 to get the badge text from. If no tab is specified, the non-tab-specific badge text is returned.

Return value

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

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 No 33

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,