index.md

---

title: sidebarAction.toggle()
slug: Mozilla/Add-ons/WebExtensions/API/sidebarAction/toggle
page-type: webextension-api-function
tags:
  - API
  - Add-ons
  - Extensions
  - Method
  - Reference
  - WebExtensions
  - sidebarAction
  - toggle
browser-compat: webextensions.api.sidebarAction.toggle

---

{{AddonSidebar()}}

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

browser.sidebarAction.toggle()

Parameters

None.

Return value

A Promise that is resolved with no arguments.

Browser compatibility

{{Compat}}

Examples

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

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

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

{{WebExtExamples}}