browserAction.setPopup()

Diese Übersetzung ist unvollständig. Bitte helfen Sie uns, diesen Artikel aus dem Englischen zu übersetzen

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
ChromeEdgeFirefoxOperaSafariFirefox für Android
setPopupChrome Vollständige Unterstützung JaEdge Vollständige Unterstützung 14Firefox Vollständige Unterstützung 45
Vollständige Unterstützung 45
Keine Unterstützung 45 — 58
Hinweise
Hinweise Tab-specific popups are not cleared when a new page is loaded.
Opera Vollständige Unterstützung JaSafari Vollständige Unterstützung 14Firefox Android Vollständige Unterstützung 57
Vollständige Unterstützung 57
Keine Unterstützung 57 — 58
Hinweise
Hinweise Tab-specific popups are not cleared when a new page is loaded.
details.windowIdChrome Keine Unterstützung NeinEdge Keine Unterstützung NeinFirefox Vollständige Unterstützung 62Opera Keine Unterstützung NeinSafari Keine Unterstützung NeinFirefox Android Keine Unterstützung Nein
The popup property of the details parameter can be set to null.Chrome Keine Unterstützung NeinEdge Keine Unterstützung NeinFirefox Vollständige Unterstützung 59Opera Keine Unterstützung NeinSafari Vollständige Unterstützung 14Firefox Android Keine Unterstützung Nein

Legende

Vollständige Unterstützung  
Vollständige Unterstützung
Keine Unterstützung  
Keine Unterstützung
Siehe Implementierungshinweise.
Siehe Implementierungshinweise.

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.