menus

创建菜单项

要创建菜单项，请调用 menus.create() 方法。您将一个包含项目选项的对象传递给此方法，包括项目 ID、项目类型以及应显示它的上下文。

在使用非持久性 后台页面（事件页面）的 Firefox 扩展程序中，或在任何 Chrome 扩展程序中，您会在 runtime.onInstalled 侦听器中调用 menus.create。在使用持久性后台页面的 Firefox 扩展程序中，您会进行顶级调用。有关更多信息，请参阅 menus.create()。

通过向 menus.onClicked 事件添加侦听器来监听您的菜单项的点击事件。此侦听器将收到一个包含事件详细信息的 menus.OnClickData 对象。

您可以根据在 create() 选项中提供的 type 属性的值创建四种不同类型的菜单项：

• "normal"：一个仅显示标签的菜单项
• "checkbox"：一个表示二进制状态的菜单项。它在标签旁边显示一个复选标记。单击该项目会切换复选标记。点击侦听器将收到两个额外的属性："checked"，指示项目当前是否已选中，以及 "wasChecked"，指示项目在点击事件之前是否已选中。
• "radio"：一个表示一组选项中一个选项的菜单项。与复选框一样，它也在标签旁边显示一个复选标记，并且其点击侦听器会收到 "checked" 和 "wasChecked" 属性。但是，如果您创建了多个单选项目，那么这些项目将作为一组单选项目运行：组中一次只能选中一个项目，单击一个项目会使其成为已选中的项目。
• "separator"：用于分隔项目组的线条。

如果您创建了多个上下文菜单项或多个工具菜单项，则这些项将放置在子菜单中。子菜单的父项将以扩展程序的名称进行标记。例如，这是一个名为“Menu demo”的扩展程序，它添加了两个上下文菜单项

图标

如果您使用 "icons" manifest 键 为您的扩展程序指定了图标，那么您的菜单项将在其标签旁边显示指定的图标。浏览器将尝试为正常显示选择一个 16x16 像素的图标，为高密度显示选择一个 32x32 像素的图标。

仅对于子菜单中的项目，您可以通过将 icons 选项传递给 menus.create() 来指定自定义图标。

示例

这是一个包含 4 个项目的上下文菜单：一个普通项目，两个带有分隔符的单选项目，以及一个复选框。单选项目被赋予了自定义图标。

您可以使用类似以下的 JavaScript 代码创建子菜单：

browser.menus.create(
  {
    id: "remove-me",
    title: browser.i18n.getMessage("menuItemRemoveMe"),
    contexts: ["all"],
  },
  onCreated,
);

browser.menus.create(
  {
    id: "separator-1",
    type: "separator",
    contexts: ["all"],
  },
  onCreated,
);

browser.menus.create(
  {
    id: "greenify",
    type: "radio",
    title: browser.i18n.getMessage("menuItemGreenify"),
    contexts: ["all"],
    checked: true,
    icons: {
      16: "icons/paint-green-16.png",
      32: "icons/paint-green-32.png",
    },
  },
  onCreated,
);

browser.menus.create(
  {
    id: "bluify",
    type: "radio",
    title: browser.i18n.getMessage("menuItemBluify"),
    contexts: ["all"],
    checked: false,
    icons: {
      16: "icons/paint-blue-16.png",
      32: "icons/paint-blue-32.png",
    },
  },
  onCreated,
);

browser.menus.create(
  {
    id: "separator-2",
    type: "separator",
    contexts: ["all"],
  },
  onCreated,
);

let checkedState = true;

browser.menus.create(
  {
    id: "check-uncheck",
    type: "checkbox",
    title: browser.i18n.getMessage("menuItemUncheckMe"),
    contexts: ["all"],
    checked: checkedState,
  },
  onCreated,
);

类型

menus.ContextType

菜单可能出现的不同上下文。

menus.ItemType

菜单项的类型："normal"（普通）、"checkbox"（复选框）、"radio"（单选）、"separator"（分隔符）。

menus.OnClickData

菜单项被点击时发送的信息。

属性

menus.ACTION_MENU_TOP_LEVEL_LIMIT

添加到上下文类型为 "browser_action" 或 "page_action" 的菜单项中的顶级扩展项的最大数量。

函数

menus.create()

创建一个新的菜单项。

menus.getTargetElement()

返回给定 info.targetElementId 的元素。

menus.overrideContext()

隐藏所有默认的 Firefox 菜单项，以提供自定义上下文菜单 UI。

menus.refresh()

更新当前正在显示的菜单。

menus.remove()

移除一个菜单项。

menus.removeAll()

移除此扩展程序添加的所有菜单项。

menus.update()

更新先前创建的菜单项。

事件

menus.onClicked

菜单项被点击时触发。

menus.onHidden

浏览器隐藏菜单时触发。

menus.onShown

浏览器显示菜单时触发。

扩展程序示例

• menu-accesskey-visible
• menu-demo
• menu-labelled-open
• menu-remove-element
• menu-search
• session-state

浏览器兼容性