browserAction.setPopup()

Sets the HTML document that will be opened as a popup when the user clicks on the browser action's icon. Tabs without a specific popup will inherit the global popup, which defaults to the default_popup specified in the manifest.

Syntax

browser.browserAction.setPopup(
  details // object
)

Parameters

details
object.
tabIdOptional
integer. Sets the popup only for a specific tab. The popup is reset when the user navigates this tab to a new page.
windowIdOptional
integer. Sets the popup only for the specified window.
popup

string or null. The HTML file to show in a popup, specified as a URL.

This can point to a file packaged within the extension (for example, created using extension.getURL), or a remote document (e.g. https://example.org/).

If an empty string ("") is passed here, the popup is disabled, and the extension will receive browserAction.onClicked events.

If popup is null:

If tabId is specified, removes the tab-specific popup so that the tab inherits the global popup.

If windowId is specified, removes the window-specific popup so that the window inherits the global popup.

Otherwise it reverts the global popup to the default value.

  • If windowId and tabId are both supplied, the function fails and the popup is not set.
  • If windowId and tabId are both omitted, the global popup is set.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support YesEdge Full support 14Firefox Full support 45
Full support 45
No support 45 — 58
Notes
Notes Tab-specific popups are not cleared when a new page is loaded.
Opera Full support YesFirefox Android Full support 57
Full support 57
No support 57 — 58
Notes
Notes Tab-specific popups are not cleared when a new page is loaded.
The popup property of the details parameter can be set to null.Chrome No support NoEdge No support NoFirefox Full support 59Opera No support NoFirefox Android No support No
details.windowIdChrome No support NoEdge No support NoFirefox Full support 62Opera No support NoFirefox Android No support No

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.

Examples

This code adds a pair of context menu items that you can use to switch between two popups. Note that you'll need the "contextMenus" permission set in the extension's manifest to create context menu items.

function onCreated() {
  if (browser.runtime.lastError) {
    console.log("error creating item:" + browser.runtime.lastError);
  } else {
    console.log("item created successfully");
  }
}

browser.contextMenus.create({
  id: "popup-1",
  type: "radio",
  title: "Popup 1",
  contexts: ["all"],
  checked: true
}, onCreated);

browser.contextMenus.create({
  id: "popup-2",
  type: "radio",
  title: "Popup 2",
  contexts: ["all"],
  checked: false
}, onCreated);

browser.contextMenus.onClicked.addListener(function(info, tab) {
  if (info.menuItemId == "popup-1") {
    browser.browserAction.setPopup({popup: "/popup/popup1.html"})
  } else if (info.menuItemId == "popup-2") {
    browser.browserAction.setPopup({popup: "/popup/popup2.html"})
  }
});

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.

Document Tags and Contributors

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