We're looking for a user researcher to understand the needs of developers and designers. Is this you or someone you know? Check out the post: https://mzl.la/2IGzdXS

Add-ons

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. If this argument is omitted, the global popup is set instead.
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 a tabId is specified, null removes the tab-specific popup so that the tab inherits the global popup. Otherwise it reverts the global popup to the default value.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support Yes144557 Yes
The popup property of the details parameter can be set to null. No No59 No No

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: wbamberg, Loirooriol, Makyen, chrisdavidmills
Last updated by: wbamberg,