browserAction.setPopup()

设置用户点击浏览器操作图标时将打开的 HTML 文档作为弹出窗口。没有指定弹出窗口的选项卡将继承全局弹出窗口，默认情况下为清单中指定的 default_popup。

语法

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

参数

details

具有以下属性的对象

tabId 可选

integer。仅为特定选项卡设置弹出窗口。当用户将此选项卡导航到新页面时，弹出窗口将重置。

windowId 可选

integer。仅为指定窗口设置弹出窗口。

string 或 null。要在弹出窗口中显示的 HTML 文件，指定为 URL。

这可以指向打包在扩展中的文件（例如，使用 extension.getURL 创建的文件），或指向远程文档（例如 https://example.org/）。

如果在此处传递空字符串 ("")，则弹出窗口将被禁用，扩展将接收 browserAction.onClicked 事件。

如果 popup 为 null

  • 如果指定了 tabId，则删除特定于选项卡的弹出窗口，以便选项卡继承全局弹出窗口。
  • 如果指定了 windowId，则删除特定于窗口的弹出窗口，以便窗口继承全局弹出窗口。
  • 如果 tabId 和 windowId 都省略，则将全局弹出窗口恢复为默认值。
  • 如果 windowId 和 tabId 都提供，则函数将失败，并且不会设置弹出窗口。
  • 如果 windowId 和 tabId 都省略，则将设置全局弹出窗口。

浏览器兼容性

BCD 表格仅在浏览器中加载

示例

此代码添加了一对上下文菜单项，您可以使用它们在两个弹出窗口之间切换。请注意，您需要在扩展的清单中设置“上下文菜单” 权限 才能创建上下文菜单项。

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

注意：此 API 基于 Chromium 的 chrome.browserAction API。此文档源自 Chromium 代码中的 browser_action.json。