Add-ons

sidebarAction.getTitle()

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.

Syntax

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

Parameters

details
object.
tabIdOptional
integer. Specify the tab to get the title from. If this is omitted or does not match the ID of an open tab, the non-tab-specific title is returned.

Return value

A Promise that will be fulfilled with a string containing the sidebar's title.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportNoNo54NoYes

Examples

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

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({});
  gettingTitle.then(toggleTitle);
});

Acknowledgements

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