index.md

---

title: action.getBadgeText()
slug: Mozilla/Add-ons/WebExtensions/API/action/getBadgeText
page-type: webextension-api-function
tags:
  - API
  - Add-ons
  - Extensions
  - Method
  - Non-standard
  - Reference
  - WebExtensions
  - action
  - getBadgeText
browser-compat: webextensions.api.action.getBadgeText

---

{{AddonSidebar()}}

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

let gettingText = browser.action.getBadgeText(
  details               // object
)

Parameters

• details

  • : An object with the following properties:

    • tabId {{optional_inline}}

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

    • windowId {{optional_inline}}

      • : 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:

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

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

{{WebExtExamples}}

Browser compatibility

{{Compat}}

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