Context Menus

Context菜单用于在Chrome的右键菜单中增加自己的菜单项。

您可以选择针对不同类型的对象（如图片，链接，页面）增加右键菜单项。

您可以根据需要添加多个右键菜单项。一个扩展里添加的多个右键菜单项会被Chrome自动组合放到对应扩展名称的二级菜单里。

右键菜单可以出现在任意文档（或文档中的框架）中，甚至是本地文件（如 file:// 或者 Chrome://）中。若想控制右键菜单在不同文档中的显示，可以在调用create()和update()时指定documentUrlPatterns。

版本说明： 低于Chrome 14的版本,右键菜单只能用于http:// 或者 https:// 类型的文档。

清单

要使用contentMenus API，您必须在清单中声明“contentMenus”权限。同时，您应该指定一个16x16的图标用作右键菜单的标识。例如：

{
        "name": "My extension",
        ...
        "permissions": [
          "contextMenus"
        ],
        "icons": {
          "16": "icon-bitty.png",
          "48": "icon-small.png",
          "128": "icon-large.png"
        },
        ...
}

范例

您可以在代码例子页面找到使用contentMenus API的简单范例。

API 参考: Chrome.contextMenus

方法

create

创建一个新的右键菜单项。注意：如果在创建的过程中出现错误，会在回调函数触发后才能捕获到，错误详细信息保存在Chrome.extension.lastError中。

参数

createProperties ( object )

Undocumented.

type ( optional enumerated string ["normal", "checkbox", "radio", "separator"] )

右键菜单项的类型。默认为“normal”。

title ( optional string )

右键菜单项的显示文字；除非为“separator”类型，否则此参数是必须的。如果类型为“selection”，您可以在字符串中使用%s显示选定的文本。例如，如果参数的值为 "Translate '%s' to Pig Latin"，而用户还选中了文本“cool”，那么显示在菜单中的将会是 "Translate 'cool' to Pig Latin"。

checked ( optional boolean )

Checkbox或者radio的初始状态：true代表选中，false代表未选中。在给定的radio中只能有一个处于选中状态。

contexts ( optional array of string ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"] )

右键菜单项将会在这个列表指定的上下文类型中显示。默认为“page”。

onclick ( optional function )

当菜单项被点击时触发的函数。

参数

info ( OnClickData )

右键菜单项被点击时相关的上下文信息。

tab ( Tab )

右键菜单项被点击时，当前标签的详细信息。

parentId ( optional integer )

右键菜单项的父菜单项ID。指定父菜单项将会使此菜单项成为父菜单项的子菜单。

documentUrlPatterns ( optional array of string )

这使得右键菜单只在匹配此模式的url页面上生效（这个对框架也适用）。详细的匹配格式见：模式匹配页面。

targetUrlPatterns ( optional array of string )

类似于documentUrlPatterns，但是您可以针对img/audio/video标签的src属性和anchor标签的href做过滤。

enabled ( optional boolean )

启用或者禁用此菜单项，启用为true，禁用为false。默认为true。

callback ( optional function )

在创建完菜单项后触发。如果创建过程中有错误产生，其详细信息在Chrome.extension.lastError中。

返回

( integer )

新创建右键菜单项的ID。

回调

如果需要指定回调函数，则回调函数格式如下：

function() {...};

remove

删除一个右键菜单。

参数

menuItemId ( integer )

待删除的右键菜单项的ID

callback ( optional function )

当右键菜单项被删除后触发。

回调

如果需要指定回调函数，则回调函数格式如下：

function() {...};

removeAll

删除此扩展添加的所有右键菜单项。

参数

callback ( optional function )

删除完成后触发。

回调

如果需要指定回调函数，则回调函数格式如下：

function() {...};

update

更新已创建的右键菜单项。

参数

id ( integer )

待更新的右键菜单项的ID.

updateProperties ( object )

待更新的属性。与创建右键菜单项时的属性参数一样。

type ( optional enumerated string ["normal", "checkbox", "radio", "separator"] )

Undocumented.

title ( optional string )

Undocumented.

checked ( optional boolean )

Undocumented.

contexts ( optional array of string ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"] )

Undocumented.

onclick ( optional function )

Undocumented.

parentId ( optional integer )

注意：不能将右键菜单项设置成自己子菜单的子菜单。

documentUrlPatterns ( optional array of string )

Undocumented.

targetUrlPatterns ( optional array of string )

Undocumented.

enabled ( optional boolean )

Undocumented.

callback ( optional function )

右键菜单项更新完成后触发。

回调

如果需要指定回调函数，则回调函数格式如下：

function() {...};

类型

OnClickData