browserAction.getBadgeText()

Gets the browser action's badge text.

This is an asynchronous function that returns a Promise.

Syntax

js
let gettingText = browser.browserAction.getBadgeText(
  details               // object
)

Parameters

details

An object with the following properties:

tabId Optional

integer. Specifies the tab from which to get the badge text.

windowId Optional

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
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
getBadgeText
details.windowId parameter

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support

Examples

Log the badge text:

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

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

Note: This API is based on Chromium's chrome.browserAction API. This documentation is derived from browser_action.json in the Chromium code.