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
.-
tabId
Optionalinteger
. Specifies the tab from which to get the badge text.windowId
Optionalinteger
. 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 GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
getBadgeText | ChromeFull supportYes | EdgeFull support14 | FirefoxFull support45 | OperaFull supportYes | SafariFull support14 | Firefox for AndroidFull support79 |
Legend
- Full support
- Full support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
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.