browserAction.setTitle()

Sets the browser action's title. The title is displayed in a tooltip over the browser action's icon. You can pass a tabId in as an optional parameter — if you do this then the title is changed only for the given tab.

Syntax

browser.browserAction.setTitle(
  details // object
)

Parameters

details
object. The new title and optionally the ID of the tab to target.
title
string. The string the browser action should display when moused over.
tabIdOptional
integer. Sets the title only for the given tab. The title is reset automatically when the tab is closed.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYes154555Yes

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(() => {
  var gettingTitle = browser.browserAction.getTitle({});
  gettingTitle.then(toggleTitle);
});

Acknowledgements

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.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,