index.md

---

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

---

{{AddonSidebar()}}

Gets the browser action's title.

Just as you can set the title on a per-tab basis using {{WebExtAPIRef("browserAction.setTitle()")}}, so you can retrieve a tab-specific title by passing the tab's ID into this function.

This is an asynchronous function that returns a Promise.

Syntax

let gettingTitle = browser.browserAction.getTitle(
  details               // object
)

Parameters

• details

  • : An object with the following properties:

    • tabId {{optional_inline}}

      • : integer. Specify the tab to get the title from.

    • windowId {{optional_inline}}

      • : integer. Specify the window to get the title from.

• If windowId and tabId are both supplied, the function fails and the promise it returns is rejected.

• If windowId and tabId are both omitted, the global title is returned.

Return value

A Promise that will be fulfilled with a string containing the browser action's title.

Browser compatibility

{{Compat}}

Examples

This code switches the title between "this" and "that" each time the user clicks the browser action:

function toggleTitle(title) {
  if (title === "this") {
    browser.browserAction.setTitle({ title: "that" });
  } else {
    browser.browserAction.setTitle({ title: "this" });
  }
}

browser.browserAction.onClicked.addListener(() => {
  let gettingTitle = browser.browserAction.getTitle({});
  gettingTitle.then(toggleTitle);
});

{{WebExtExamples}}

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