sidebarAction.toggle()

Toggles the visibility of the sidebar in the active window, if the sidebar belongs to the extension.

You can only call this function from inside the handler for a user action.

This is an asynchronous function that returns a Promise.

Syntax

js
browser.sidebarAction.toggle()

Parameters

None.

Return value

A Promise that is resolved with no arguments.

Browser compatibility

Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
toggle

Examples

Toggles the sidebar when the user selects an item from the context menu:

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

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