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
js
let gettingPanel = browser.sidebarAction.getPanel(
details // object
)
Parameters
details
-
object
. An object with the following properties:tabId
Optional-
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
andtabId
are both supplied, the function fails and the promise it returns is rejected. - If
windowId
andtabId
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 qualified URL, such as:
url
moz-extension:/sidebar.html
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
getPanel |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
Get the panel's URL:
js
function onGot(sidebarUrl) {
console.log(sidebarUrl);
}
let gettingPanel = browser.sidebarAction.getPanel({});
gettingPanel.then(onGot);
Note:
This API is based on Opera's chrome.sidebarAction
API.