--- title: contextMenus slug: Mozilla/Add-ons/WebExtensions/API/contextMenus tags: - API - WebExtensions - contextMenus translation_of: Mozilla/Add-ons/WebExtensions/API/menus ---
{{AddonSidebar}}
在浏览器菜单中添加条目。
此API基于Chrome的“contextMenus”API构建，该API可让Chrome扩展程序将项目添加到浏览器的上下文菜单中。 browser.menus API为Chrome的API添加了一些功能，特别是可以将项目添加到浏览器的“工具”菜单以及上下文菜单中。
在Firefox 55之前，这个API最初也被命名为contextMenus，并且这个名字被保留为别名，所以你可以使用contextMenus编写在Firefox和其他浏览器中工作的代码。
你需要拥有“menus”（或别名" contextMenus "）权限来使用此API。

创建菜单项

使用 {{WebExtAPIRef("menus.create()")}}方法创建一个菜单项。你需要传递一个包含条目选项的对象，它包括条目的id，类型，和需要显示出来的文本值。

绑定一个监听器到{{WebExtAPIRef("contextMenus.onClicked")}}事件来监听你菜单项目的点击事件。此监听器会传递一个{{WebExtAPIRef("contextMenus.OnClickData")}}，它包含该事件的详细信息。

你可以根据在调用create()时所传递的参数中使用不同的type值来创建四种不同类型的菜单：

如果您创建了多个上下文菜单项目或多个工具菜单项目，则这些项目将被放置在子菜单中。 子菜单的父项将标有扩展名。 例如，下面是一个名为“Menu Demo”的扩展，添加了两个上下文菜单项：

图标

如果你使用 "icons" manifest key 为你的扩展指定一个图标，你的菜单项的旁边就会显示一个指定的图标。浏览器会尝试在普通分辨率下使用16 x 16像素的图标，在高分辨率下使用32 x 32像素的图标：

你可以通过调用 {{WebExtAPIRef("menus.create()")}} 时指定icons选项来给子菜单项设置图标。

例子

下面是一个包含四个项目的菜单，他们分别是：一个普通选项，两个周围有分割线的单选，和一个复选框。单选框使用了自定义图标。

你可以使用以下代码创建一个这样的子菜单：

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

var checkedState = true;

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

类型

{{WebExtAPIRef("contextMenus.ContextType")}}
菜单里可以出现的不同内容。可能的值有："all", "audio", "browser_action", "editable", "frame", "image", "link", "page", "page_action", "password", "selection", "tab", "video".
{{WebExtAPIRef("contextMenus.ItemType")}}
菜单项的类别有: "normal", "checkbox", "radio", "separator".
{{WebExtAPIRef("contextMenus.OnClickData")}}
当菜单项被点击时发送的信息。

属性

{{WebExtAPIRef("contextMenus.ACTION_MENU_TOP_LEVEL_LIMIT")}}
可以被添加进上下文菜单项的顶级扩展项的最大值，其ContextType可以是"browser_action" 或者 "page_action".

函数

{{WebExtAPIRef("contextMenus.create()")}}
创建一个新的上下文菜单项目。
{{WebExtAPIRef("contextMenus.update()")}}
更新一个已经创建了的上下文菜单项目。
{{WebExtAPIRef("contextMenus.remove()")}}
删除一个上下文菜单项目。
{{WebExtAPIRef("contextMenus.removeAll()")}}
移除该插件创建的所有上下文菜单项目。

事件

{{WebExtAPIRef("contextMenus.onClicked")}}
当一个上下文菜单项被点击时触发。

浏览器兼容性

{{ Compat("webextensions.api.menus", 1, "true") }}

{{WebExtExamples("h2")}}

致谢

此API基于Chromium的 chrome.contextMenus API. 此文档来自于Chromium代码中的context_menus.json。