action.getBadgeText()
Gets the browser action's badge text.
Note: This API is available in Manifest V3 or higher.
This is an asynchronous function that returns a Promise.
Syntax
js
let gettingText = browser.action.getBadgeText(
details // object
)
Parameters
details-
An object with the following properties:
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.
Examples
Log the badge text:
js
function gotBadgeText(text) {
console.log(text);
}
let gettingBadgeText = browser.action.getBadgeText({});
gettingBadgeText.then(gotBadgeText);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
getBadgeText
|
|
|
|
|
|
|
|
details.windowId parameter
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
Note:
This API is based on Chromium's chrome.action API. This documentation is derived from browser_action.json in the Chromium code.