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. An object with the following properties:
tabIdOptional
integer. Get the panel for the sidebar specific to the given tab.
windowId Optional
integer. Get the panel 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 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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome 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

Legend

Full support  
Full support
No support  
No support

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