action.getPopup()
Gets the HTML document set as the popup for this browser action.
Note: This API is available in Manifest V3 or higher.
This is an asynchronous function that returns a Promise
.
Syntax
js
let gettingPopup = browser.action.getPopup(
details // object
)
Parameters
details
-
An object with the following properties:
tabId
Optional-
integer
. The tab whose popup to get. windowId
Optional-
integer
. The windows whose popup to get.
- If
windowId
andtabId
are both supplied, the function fails. - If
windowId
andtabId
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 qualified URL, such as moz-extension://d1d8a2eb-fe60-f646-af30-a866c5b39942/popups/popup2.html
.
Examples
Get the popup's URL:
js
function gotPopup(popupURL) {
console.log(popupURL);
}
let gettingPopup = browser.action.getPopup({});
gettingPopup.then(gotPopup);
Browser compatibility
BCD tables only load in the browser
Note: This API is based on Chromium's chrome.action
API. This documentation is derived from browser_action.json
in the Chromium code.