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

Update compatibility data on GitHub

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Firefox for Android
`getPopup`	Chrome Full support Yes	Edge Full support 79	Firefox Full support 45	Opera Full support Yes	Safari Full support 14	Firefox Android Full support 57
`details.windowId`	Chrome No support No	Edge No support No	Firefox Full support 62	Opera No support No	Safari No support No	Firefox Android No support No

Legend

Full support: Full support
No support: No support

Examples

Get the popup's URL:

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

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

Acknowledgements

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.

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.