index.md

---

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

---

{{AddonSidebar()}}

Gets the URL for the HTML document set as the popup for this page action.

This is an asynchronous function that returns a Promise.

Syntax

let gettingPopup = browser.pageAction.getPopup(
  details               // object
)

Parameters

• details

  • : object.

    • tabId

      • : integer. ID of the tab whose popup you want to get.

Return value

A Promise that will be fulfilled with a string containing the popup's URL.

Browser compatibility

{{Compat}}

Examples

Add a context menu item that logs the popup URL for the current tab. Note that you'll need the contextMenus permission in your manifest to create context menu items.

function gotPopup(popupURL) {
  console.log(popupURL);
}

browser.contextMenus.create({
  id: "get-popup",
  title: "Get popup URL"
});

browser.contextMenus.onClicked.addListener((info, tab) => {
  if (info.menuItemId === "get-popup") {
    let gettingPopup = browser.pageAction.getPopup({tabId: tab.id});
    gettingPopup.then(gotPopup);
  }
});

{{WebExtExamples}}

Note: This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.