W3cubDocs

/Web Extensions

browserAction.getPopup()

Gets the HTML document set as the popup for this browser action.

This is an asynchronous function that returns a Promise.

Syntax

var gettingPopup = browser.browserAction.getPopup(
  details               // object
)

Parameters

details
object.
tabIdOptional
integer. The tab whose popup to get.
windowIdOptional
integer. The windows whose popup to get.
  • If windowId and tabId are both supplied, the function fails.
  • If windowId and tabId are both omitted, the global popup is returned.

Return value

A Promise that will be fulfilled with a string containing the URL for the popup's document. This will be a fully qualifed URL, such as moz-extension://d1d8a2eb-fe60-f646-af30-a866c5b39942/popups/popup2.html.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
getPopup
Yes
79
45
?
Yes
14
?
?
57
?
?
?

Examples

Get the popup's URL:

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

var gettingPopup = browser.browserAction.getPopup({});
gettingPopup.then(gotPopup); 

Note: This API is based on Chromium's chrome.browserAction API. This documentation is derived from browser_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.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/browserAction/getPopup