browserAction.setPopup()

设置当用户点击浏览器操作图标时将打开的弹出窗口的 HTML 文档。没有特定弹出窗口的标签页将继承全局弹出窗口,全局弹出窗口默认为清单中指定的 default_popup

语法

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

参数

details

具有以下属性的对象:

tabId 可选

integer。仅为特定标签页设置弹出窗口。当用户将此标签页导航到新页面时,弹出窗口将重置。

windowId 可选

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

stringnull。显示在弹出窗口中的 HTML 文件,指定为 URL。

这可以指向打包在扩展程序中的文件(例如,使用 extension.getURL 创建的文件),也可以指向远程文档(例如,https://example.org/)。

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

如果 popupnull

  • 如果指定了 tabId,则会删除特定于标签页的弹出窗口,以便标签页继承全局弹出窗口。
  • 如果指定了 windowId,则会删除特定于窗口的弹出窗口,以便窗口继承全局弹出窗口。
  • 如果同时省略了 tabIdwindowId,则全局弹出窗口将恢复为默认值。
  • 如果同时提供了 windowIdtabId,则函数将失败,并且不会设置弹出窗口。
  • 如果同时省略了 windowIdtabId,则将设置全局弹出窗口。

示例

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

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