1. Mozilla
  2. Add-ons
  3. Browser extensions
  4. JavaScript APIs
  5. pageAction
  6. pageAction.setPopup()

pageAction.setPopup()

Sets the HTML document to be opened as a popup when the user clicks on the page action's icon.

Syntax

js
browser.pageAction.setPopup(
  details // object
)

Parameters

details

object.

tabId

integer. The ID of the tab for which you want to set the popup.

string or null. URL to the HTML file to show in a popup.

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

If null is passed here, the popup is reset to the popup that was specified in the page_action manifest key.

Examples

Listen for tabs.onUpdated events, and switch the popup if the loading status changes:

js
browser.tabs.onUpdated.addListener((tabId, changeInfo, tabInfo) => {
  if (changeInfo.status) {
    browser.pageAction.show(tabId);
    if (changeInfo.status === "loading") {
      browser.pageAction.setPopup({
        tabId,
        popup: "/popup/loading.html",
      });
    } else {
      browser.pageAction.setPopup({
        tabId,
        popup: "/popup/complete.html",
      });
    }
  }
});

Browser compatibility

Note: This API is based on Chromium's chrome.pageAction API. This documentation is derived from page_action.json in the Chromium code.

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content