Add-ons

devtools.panels.ExtensionSidebarPane

The ExtensionSidebarPane object represents a pane that an extension has added to the sidebar in the browser's HTML/CSS inspector.

To create an ExtensionSidebarPane, call the browser.devtools.panels.elements.createSidebarPane() function.

Functions

devtools.panels.ExtensionSidebarPane.setExpression()

Evaluate a JavaScript expression in the web page that the inspector is inspecting. The result is displayed in the sidebar pane.

devtools.panels.ExtensionSidebarPane.setObject()

Sets a JSON object that will be displayed in the sidebar pane.

Events

devtools.panels.ExtensionSidebarPane.onShown
Fired when the sidebar pane is shown.
devtools.panels.ExtensionSidebarPane.onHidden
Fired when the sidebar pane is hidden.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
onHidden Yes No571 No Yes
onShown Yes No571 No Yes
setExpression Yes2 No573 No Yes
setObject Yes4 No575 No Yes

1. This event is only fired when the user switches between sidebar panes, not when the user switches between devtools panels. See bug 1412317.

2. The expression must evaluate to a JavaScript object or a DOM node, or nothing is shown in the sidebar.

3. The expression must evaluate to an object that can be serialized to JSON, or nothing is shown in the sidebar. In particular, JavaScript cyclic objects and DOM nodes are not supported. See bug 1403130.

4. If the jsonObject parameter is a string, it is not displayed.

5. If the jsonObject is a string, then rootTitle must also be given, or jsonObject will not be displayed. See bug 1412310.

Acknowledgements

This API is based on Chromium's chrome.devtools.panels API.

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,