Sets the sidebar's panel: that is, the HTML document that defines the content of this sidebar.
Sidebars always have a
"manifest panel"
, which is the panel defined in the
sidebar_action
manifest key.
If you set a new panel using
setPanel()
, and include the
tabId
option, then the panel is set only for the given tab. This panel is referred to as the
"tab-specific panel"
.
If you set a new panel using
setPanel()
, and include the
windowId
option, then the panel is set only for the given window. This panel is referred to as the
"window-specific panel"
, and will appear in all tabs of that window that do not have a tab-specific panel set.
If you set a new panel using
setPanel()
, and omit both the
tabId
and
windowId
options, then this sets the
"global panel"
. The global panel will then appear in all tabs that do not have a tab-specific panel set and whose window does not have a window-specific panel.
browser.sidebarAction.setPanel(
details
// object
)
details
对象
. An object with the following properties:
panel
string
or
null
. The panel to load into the sidebar, specified as a URL pointing to an HTML document, or
null
, or an empty string.
This can point to a file packaged within the extension (for example, created using
runtime.getURL
), or a remote document (e.g.
https://example.org/
). It must be a valid URL.
若
panel
is
null
or
""
, then a previously set panel will be removed, so that:
tabId
is specified, and the tab has a tab-specific panel set, then the tab will inherit the panel from the window it belongs to.
windowId
is specified, and the window has a window-specific panel set, then the window will inherit the global panel.
tabId
可选
integer
. Sets the panel only for the given tab.
windowId
可选
integer
. Sets the panel only for the given window.
windowId
and
tabId
are both specified, the function fails and the panel is not set.
windowId
and
tabId
are both omitted, the global panel is set.
This code toggles the sidebar document when the user clicks a browser action:
var thisPanel = browser.runtime.getURL("/this.html");
var thatPanel = browser.runtime.getURL("/that.html");
function toggle(panel) {
if (panel === thisPanel) {
browser.sidebarAction.setPanel({panel: thatPanel});
} else {
browser.sidebarAction.setPanel({panel: thisPanel});
}
}
browser.browserAction.onClicked.addListener(() => {
browser.sidebarAction.getPanel({}).then(toggle);
});
BCD tables only load in the browser
注意：
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.
最后修改： , 由 MDN 贡献者