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
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
onHidden | Yes | No | 571 | No | Yes |
onShown | Yes | No | 571 | No | Yes |
setExpression | Yes2 | No | 573 | No | Yes |
setObject | Yes4 | No | 575 | 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.
This API is based on Chromium's chrome.devtools.panels
API.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.