Gets the sidebar's title.

Just as you can set the title on a per-tab basis using sidebarAction.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.


var gettingTitle = browser.sidebarAction.getTitle(
  details               // object


object. An object with the following properties:
integer. Get the title for the sidebar specific to the given tab.
windowId Optional
integer. Get the title for the sidebar specific to the given window.
  • 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 sidebar's title.

Browser compatibility

Update compatibility data on GitHub
ChromeEdgeFirefoxOperaFirefox for Android
getTitleChrome No support NoEdge No support NoFirefox Full support 54Opera Full support 30Firefox Android No support No
details.windowIdChrome No support NoEdge No support NoFirefox Full support 61Opera No support NoFirefox Android No support No


Full support  
Full support
No support  
No support


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

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

browser.browserAction.onClicked.addListener(() => {
  var gettingTitle = browser.sidebarAction.getTitle({});


This API is based on Opera's chrome.sidebarAction API.

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: mdnwebdocs-bot, wbamberg, hellosct1, ExE-Boss
Last updated by: mdnwebdocs-bot,