Add-ons

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. Tabs without a specific title will inherit the global title text, which defaults to the default_title or name specified in the manifest.

Syntax

browser.browserAction.setTitle(
  details // object
)

Parameters

details
object. The new title and optionally the ID of the tab to target.
title

string or null. The string the browser action should display when moused over.

If title is an empty string, the used title will be the extension name, but browserAction.getTitle will still provide the empty string.

If a tabId is specified, null removes the tab-specific title so that the tab inherits the global title. Otherwise it reverts the global title to the default value.

tabIdOptional

integer. Sets the title only for the given tab. The title is reset when the user navigates this tab to a new page. If this argument is omitted, the global title is set instead.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes15

45

45 — 581

55

55 — 581

Yes
The title property of the details parameter can be set to null. No No59 No No

1. Tab-specific titles are not cleared when a new page is loaded.

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);
});

Example extensions

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: Loirooriol, wbamberg, Makyen, chrisdavidmills
Last updated by: Loirooriol,