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 or a windowId as an optional parameter — if you do this then the title is changed only for the given tab or the given window. Tabs or windows 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 or window to target.
  1. 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 title is null:

  • If tabId is specified, and the tab has a tab-specific title set, then the tab will inherit the title from the window to which it belongs.
  • if windowId is specified, and the window has a window-specific title set, then the window will inherit the global title.
  • Otherwise, the global title will be reset to the manifest title.
tabIdOptional

integer. Sets the title only for the given tab.

windowIdOptional

integer. Sets the title for the given window.

  • If windowId and tabId are both supplied, the function fails and the title is not set.
  • If windowId and tabId are both omitted, the global title is set.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge Full support 15Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific titles are not cleared when a new page is loaded.
Opera Full support YesFirefox Android Full support 55
Full support 55
No support 55 — 58
Notes
Notes Tab-specific titles are not cleared when a new page is loaded.
The title property of the details parameter can be set to null.Chrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android No support No
details.windowIdChrome No support NoEdge No support NoFirefox Full support 62Opera No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

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

Last updated by: ExE-Boss,