index.md

title	slug	page-type	browser-compat
action.openPopup()	Mozilla/Add-ons/WebExtensions/API/action/openPopup	webextension-api-function	webextensions.api.action.openPopup

{{AddonSidebar}}

Open the browser action's popup.

Note

This API is available in Manifest V3 or higher.

In stable versions of Firefox, you can only call this function from inside the handler for a user action. See Browser compatibility for details.

Syntax

browser.action.openPopup(
  options // optional object
)

Parameters

• details {{optional_inline}}

  • : An object with the following properties:

    • windowId {{optional_inline}}
      • : integer. Window to open the popup for. Defaults to the current window.

Return value

A Promise that is resolved with no arguments.

Examples

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

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

browser.menus.onClicked.addListener(() => {
  browser.action.openPopup();
});

{{WebExtExamples}}

Browser compatibility

{{Compat}}