devtools.panels.ExtensionSidebarPane.setPage()

Sets an HTML page to be displayed in the sidebar pane.

This is an asynchronous function that returns a Promise.

Syntax

browser.devtools.panels.setPage(
  path // string containing relative path to page
)

Parameters

extensionPageURL
string. The relative path of an HTML page to display within the sidebar.

Return value

A Promise that will be fulfilled with no arguments, once the URL has been set.

The selected page will not be loaded until the user selects the devtools sidebar.

Examples

Create a new pane, and populate it with an HTML page. You could run this code in a script loaded by your extension's devtools page.

function onCreated(sidebarPane) {
  sidebarPane.setPage('sidebar/sidebar.html');
}

Browser compatibility

No compatibility data found. Please contribute data for "webextensions.api.devtools.panels.ExtensionSidebarPane.setPage" (depth: 10) to the MDN compatibility data repository.

Acknowledgements

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

 

Document Tags and Contributors

Contributors to this page: mdnwebdocs-bot, hellosct1, irenesmith
Last updated by: mdnwebdocs-bot,