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.

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();
});

Browser compatibility

desktop mobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
toggle
Chrome – No support
Chrome
footnote No support
Edge – No support
Edge
footnote No support
Firefox – Full support
Firefox 73 (Release date: 2020-02-11)
footnote Full support
Opera – No support
Opera
footnote No support
Safari – No support
Safari
footnote No support
Firefox for Android – No support
Firefox for Android
footnote No support
Safari on iOS – No support
Safari on iOS
footnote No support

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support