Creates a new menu item, given an options object defining properties for the item.
Unlike other asynchronous functions, this one does not return a promise, but uses an optional callback to communicate success or failure. This is because its return value is the ID of the new item.
For compatibility with other browsers, Firefox makes this method available via the
contextMenus
namespace as well as the
menus
namespace. Note though that it's not possible to create tools menu items (
contexts: ["tools_menu"]
) 使用
contextMenus
名称空间。
browser.menus.create(
createProperties
,
// object
function
(
)
{
...
}
// optional function
)
createProperties
对象
. Properties for the new menu item.
checked
可选
boolean
. The initial state of a checkbox or radio item:
true
for selected and
false
for unselected. Only one radio item can be selected at a time in a given group of radio items.
命令
可选
string
. String describing an action that should be taken when the user clicks the item. Possible values are:
"_execute_browser_action"
: simulate a click on the extension's browser action, opening its popup if it has one
"_execute_page_action"
: simulate a click on the extension's page action, opening its popup if it has one
"_execute_sidebar_action"
: open the extension's sidebar
Clicking the item will still trigger the
menus.onClicked
event, but there's no guarantee of the ordering here: the command may be executed before
onClicked
fires.
上下文
可选
array
of
. Array of contexts in which this menu item will appear. If this option is omitted:
menus.ContextType
documentUrlPatterns
可选
array
of
string
. Lets you restrict the item to apply only to documents whose URL matches one of the given
match patterns
. This applies to frames as well.
enabled
可选
boolean
. Whether this menu item is enabled or disabled. Defaults to
true
.
icons
可选
对象
. One or more custom icons to display next to the item. Custom icons can only be set for items appearing in submenus. This property is an object with one property for each supplied icon: the property's name should include the icon's size in pixels, and path is relative to the icon from the extension's root directory. The browser tries to choose a 16x16 pixel icon for a normal display or a 32x32 pixel icon for a high-density display. To avoid any scaling, you can specify icons like this:
"icons": {
"16": "path/to/geo-16.png",
"32": "path/to/geo-32.png"
}
Alternatively, you can specify a single SVG icon, and it will be scaled appropriately:
"icons": {
"16": "path/to/geo.svg"
}
注意： The top-level menu item uses the icons specified in the manifest rather than what is specified with this key.
id
可选
string
. The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.
onclick
可选
function
. A function that will be called when the menu item is clicked. Event pages cannot use this: instead, they should register a listener for
menus.onClicked
.
parentId
可选
integer
or
string
. The ID of a parent menu item; this makes the item a child of a previously added item. Note: If you have created more than one menu item, then the items will be placed in a submenu. The submenu's parent will be labeled with the name of the extension.
targetUrlPatterns
可选
array
of
string
. Similar to
documentUrlPatterns
, but lets you filter based on the
href
of anchor tags and the
src
attribute of img/audio/video tags. This parameter supports any URL scheme, even those that are usually not allowed in a match pattern.
title
可选
string
. The text to be displayed in the item. Mandatory unless
type
is "separator".
You can use "
%s
" in the string. If you do this in a menu item, and some text is selected in the page when the menu is shown, then the selected text will be interpolated into the title. For example, if
title
is "Translate '%s' to Pig Latin" and the user selects the word "cool", then activates the menu, then the menu item's title will be: "Translate 'cool' to Pig Latin".
If the title contains an ampersand "&" then the next character will be used as an access key for the item, and the ampersand will not be displayed. Exceptions to this are:
Only the first ampersand will be used to set an access key: subsequent ampersands will not be displayed but will not set keys. So "&A and &B" will be shown as "A and B" and set "A" as the access key.
In some localized versions of Firefox (Japanese and Chinese), the access key is surrounded by parentheses and appended to the menu label,
unless
the menu title itself already ends with the access key (
"toolkit(&K)"
for example). For more details, see
bug 1647373
.
type
可选
. The type of menu item: "normal", "checkbox", "radio", "separator". Defaults to "normal".
menus.ItemType
viewTypes
可选
. List of view types where the menu item will be shown. Defaults to any view, including those without a
extension.ViewType
viewType
.
visible
可选
boolean
. Whether the item is shown in the menu. Defaults to
true
.
callback
可选
function
. Called when the item has been created. If there were any problems creating the item, details will be available in
runtime.lastError
.
integer
or
string
。
ID
of the newly created item.
This example creates a context menu item that's shown when the user has selected some text in the page. It just logs the selected text to the console:
browser.menus.create({
id: "log-selection",
title: "Log '%s' to the console",
contexts: ["selection"]
});
browser.menus.onClicked.addListener(function(info, tab) {
if (info.menuItemId == "log-selection") {
console.log(info.selectionText);
}
});
This example adds two radio items, which you can use to choose whether to apply a green or a blue border to the page. Note that this example will need the activeTab permission .
function onCreated() {
if (browser.runtime.lastError) {
console.log("error creating item:" + browser.runtime.lastError);
} else {
console.log("item created successfully");
}
}
browser.menus.create({
id: "radio-green",
type: "radio",
title: "Make it green",
contexts: ["all"],
checked: false
}, onCreated);
browser.menus.create({
id: "radio-blue",
type: "radio",
title: "Make it blue",
contexts: ["all"],
checked: false
}, onCreated);
var makeItBlue = 'document.body.style.border = "5px solid blue"';
var makeItGreen = 'document.body.style.border = "5px solid green"';
browser.menus.onClicked.addListener(function(info, tab) {
if (info.menuItemId == "radio-blue") {
browser.tabs.executeScript(tab.id, {
code: makeItBlue
});
} else if (info.menuItemId == "radio-green") {
browser.tabs.executeScript(tab.id, {
code: makeItGreen
});
}
});
BCD tables only load in the browser
注意：
This API is based on Chromium's
chrome.contextMenus
API. This documentation is derived from
context_menus.json
in the Chromium code.
最后修改： , 由 MDN 贡献者