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
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
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
getBadgeText |
Yes |
14 |
45 |
? |
Yes |
14 |
? |
? |
79 |
? |
? |
? |
Examples
Log the badge text:
function gotBadgeText(text) { console.log(text); } var 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.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction/getBadgeText