Add-ons

devtools.panels.ExtensionSidebarPane.onShown

Fired when the sidebar pane becomes visible as a result of the user switching to it.

Syntax

browser.devtools.panels.onShown.addListener(listener)
browser.devtools.panels.onShown.removeListener(listener)
browser.devtools.panels.onShown.hasListener(listener)

Events have three functions:

addListener(callback)
Adds a listener to this event.
removeListener(listener)
Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener)
Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback

Function that will be called when this event occurs. The function will be passed no arguments.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes No571 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.

Examples

Create a sidebar pane, and log show and hide events.

function onCreated(sidebarPane) {
 
  sidebarPane.onShown.addListener(() => {
    console.log("Shown");
  });

  sidebarPane.onHidden.addListener(() => {
    console.log("Hidden");
  });

}

browser.devtools.panels.elements.createSidebarPane("My pane").then(onCreated);

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,