pageAction.getPopup()

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

var gettingPopup = browser.pageAction.getPopup(
  details,               // object
  function(result) {...} // function
)

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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 50.0 33

Compatibility notes

Firefox for Android

  • The 'tabId' parameter is ignored: the page action popup is the same for all tabs.

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(function(info, tab) {
  if (info.menuItemId == "get-popup") {
    var gettingPopup = browser.pageAction.getPopup({tabId: tab.id});
    gettingPopup.then(gotPopup);
  }
});

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: wbamberg, Makyen, chrisdavidmills
 Last updated by: wbamberg,