browserAction.setPopup()

Setzt das HTML-Dokument, das als Popup geöffnet wird, wenn der Benutzer auf das Symbol der Browser-Aktion klickt. Tabs ohne ein spezifisches Popup erben das globale Popup, das standardmäßig im Manifest als default_popup angegeben ist.

Syntax

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

Parameter

details

Ein Objekt mit den folgenden Eigenschaften:

tabId Optional

integer. Setzt das Popup nur für einen bestimmten Tab. Das Popup wird zurückgesetzt, wenn der Benutzer diesen Tab zu einer neuen Seite navigiert.

windowId Optional

integer. Setzt das Popup nur für das angegebene Fenster.

string oder null. Die HTML-Datei, die in einem Popup angezeigt werden soll, angegeben als URL.

Dies kann auf eine Datei innerhalb der Erweiterung verweisen (zum Beispiel erstellt mit extension.getURL), oder auf ein entferntes Dokument (z.B. https://example.org/).

Wenn hier ein leerer String ("") übergeben wird, wird das Popup deaktiviert und die Erweiterung erhält browserAction.onClicked-Ereignisse.

Wenn popup null ist:

  • Wenn tabId angegeben ist, entfernt es das tab-spezifische Popup, sodass der Tab das globale Popup erbt.
  • Wenn windowId angegeben ist, entfernt es das fenster-spezifische Popup, sodass das Fenster das globale Popup erbt.
  • Wenn tabId und windowId beide weggelassen werden, wird das globale Popup auf den Standardwert zurückgesetzt.
  • Wenn windowId und tabId beide angegeben sind, schlägt die Funktion fehl und das Popup wird nicht gesetzt.
  • Wenn windowId und tabId beide weggelassen werden, wird das globale Popup gesetzt.

Browser-Kompatibilität

Beispiele

Dieser Code fügt ein Paar von Kontextmenüelementen hinzu, mit denen Sie zwischen zwei Popups wechseln können. Beachten Sie, dass Sie die "contextMenus" Erlaubnis im Manifest der Erweiterung setzen müssen, um Kontextmenüelemente zu erstellen.

js
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((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" });
  }
});

Hinweis: Diese API basiert auf der chrome.browserAction-API von Chromium. Diese Dokumentation stammt aus browser_action.json im Chromium-Code.