Add-ons

sidebarAction.open()

Open the sidebar in the active window.
 

You can only call this function from inside the handler for a user action, such as:

  • Clicking the extension's browser action or page action.
  • Selecting a context menu item defined by the extension.
  • Activating a keyboard shortcut defined by the extension (note: this is not currently supported in Firefox).
  • Clicking a button in a page bundled with the extension.

Syntax

browser.sidebarAction.open()

Parameters

None.

Return value

A Promise that is resolved with no arguments.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support No No57 No No

Examples

Open the sidebar when the user selects a context menu item:

browser.menus.create({
  id: "open-sidebar",
  title: "open sidebar",
  contexts: ["all"]
});

browser.menus.onClicked.addListener(() => {
  browser.sidebarAction.open();
});

Document Tags and Contributors

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