W3cubDocs

/Web Extensions

devtools.panels

Note: Although the APIs are based on the Chrome devtools APIs, there are still many features that are not yet implemented in Firefox, and therefore are not documented here. To see which features are currently missing please see Limitations of the devtools APIs.

The devtools.panels API lets a devtools extension define its user interface inside the devtools window.

The devtools window hosts a number of separate tools - the JavaScript Debugger, Network Monitor, and so on. A row of tabs across the top lets the user switch between the different tools. The window hosting each tool's user interface is called a "panel".

With the devtools.panels API you can create new panels in the devtools window.

Like all the devtools APIs, this API is only available to code running in the document defined in the devtools_page manifest.json key, or in other devtools documents created by the extension (such as the panel's own document). See Extending the developer tools for more.

Types

devtools.panels.ElementsPanel
Represents the HTML/CSS inspector in the browser's devtools.
devtools.panels.ExtensionPanel
Represents a devtools panel created by the extension.
devtools.panels.ExtensionSidebarPane
Represents a pane that an extension has added to the HTML/CSS inspector in the browser's devtools.

Properties

devtools.panels.elements
A reference to an ElementsPanel object.
devtools.panels.themeName
The name of the current devtools theme.

Functions

devtools.panels.create()
Creates a new devtools panel.

Events

devtools.panels.onThemeChanged
Fired when the devtools theme changes.

Example extensions

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
create
Yes
79
54
?
Yes
No
?
?
No
?
?
?
elements
Yes
79
56
?
Yes
No
?
?
No
?
?
?
onThemeChanged
No
No
55
?
No
No
?
?
No
?
?
?
themeName
59
79
55
?
41
No
?
?
No
?
?
?

Example extensions

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/devtools/panels