menus.update() 编辑

Updates a previously created menu item.

For compatibility with other browsers, Firefox makes this method available via the contextMenus namespace as well as the menus namespace.

This is an asynchronous function that returns a Promise.

Syntax

var updating = browser.menus.update(
  id,               // integer or string
  updateProperties // object
)

Parameters

id

integer or string. The ID of the item to update.

updateProperties

object. The properties to update. The same as the createProperties object passed to menus.create(), except that id can't be set. In addition, icons can only be changed on menu commands, not on the top-level context menu. The top-level icon matches the extension's primary icon as declared in the extension's manifest file.

checked Optional

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.

command Optional

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.

contexts Optional

array of menus.ContextType. Array of contexts in which this menu item will appear. If this option is omitted:

• if the item's parent has contexts set, then this item will inherit its parent's contexts
• otherwise, the item is given a context array of ["page"].

documentUrlPatterns Optional

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 Optional

boolean. Whether this menu item is enabled or disabled. Defaults to true.

icons Optional

object. 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"
    }

Note: The top-level menu item uses the icons specified in the manifest rather than what is specified with this key.

id Optional

string. The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.

onclick Optional

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 Optional

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 Optional

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 Optional

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:

• If the next character is also an ampersand: then a single ampersand will be displayed and no access key will be set. In effect, "&&" is used to display a single ampersand.
• If the next characters are the interpolation directive "%s": then the ampersand will not be displayed and no access key will be set.
• If the ampersand is the last character in the title: then the ampersand will not be displayed and no access key will be set.

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.

type Optional

menus.ItemType. The type of menu item: "normal", "checkbox", "radio", "separator". Defaults to "normal".

viewTypes Optional

extension.ViewType. List of view types where the menu item will be shown. Defaults to any view, including those without a viewType.

visible Optional

boolean. Whether the item is shown in the menu. Defaults to true.

Return value

A Promise that will be fulfilled with no arguments if the update was successful, or rejected with an error message if the update failed.

Examples

This example creates a menu item, then updates its title when the user clicks it:

function onUpdated() {
  console.log("item updated successfully");
}

function onError() {
  console.log("error updating item:" + browser.runtime.lastError);
}

browser.menus.create({
  id: "do-not-click-me",
  title: "Do not click this button",
  contexts: ["all"]
});

browser.menus.onClicked.addListener(function(info, tab) {
  if (info.menuItemId == "do-not-click-me") {
    var updating = browser.menus.update(info.menuItemId, {
      title: "Do not click this button again"
    });
    updating.then(onUpdated, onError);
  }
});

Example extensions

• menu-accesskey-visible
• menu-demo
• menu-labelled-open

Browser compatibility

BCD tables only load in the browser

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

This API is based on Chromium's chrome.contextMenus API. This documentation is derived from context_menus.json in the Chromium code.

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.