sidebarAction.getPanel()

Gets a URL to the HTML document that defines the sidebar's contents.

This is an asynchronous function that returns a Promise.

Syntax

var gettingPanel = browser.sidebarAction.getPanel(
  details               // object
)

Parameters

details
object.
tabIdOptional
integer. The tab whose panel to get. If no tab is specified, the non-tab-specific panel is returned.

Return value

A Promise that will be fulfilled with a string containing the URL for the panel's document. This will be a fully qualifed URL, such as:

moz-extension://d1d8a2eb-fe60-f646-af30-a866c5b39942/sidebar.html

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support No No 54.0 No Yes

Examples

Get the panel's URL:

function onGot(sidebarUrl) {
  console.log(sidebarUrl);
}

var gettingPanel = browser.sidebarAction.getPanel({});
gettingPanel.then(onGot); 

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,