action.getTitle()

Gets the browser action's title.

Note: This API is available in Manifest V3 or higher.

Just as you can set the title on a per-tab basis using action.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.action.getTitle(
  details               // object
)

Parameters

details

An object with the following properties:

tabIdOptional

integer. Specify the tab to get the title from.

windowIdOptional

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.

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.action.setTitle({title: "that"});
  } else {
    browser.action.setTitle({title: "this"});
  }
}

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

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.action 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.