この記事はまだボランティアによって 日本語 に翻訳されていません。ぜひ MDN に参加して翻訳を手伝ってください!
Updates a previously created context menu item.
Syntax
chrome.contextMenus.update( id, // integer or string updateProperties, // object function() {...} // optional function )
This API is also available as browser.contextMenus.update()
in a version that returns a promise.
Parameters
id
orinteger
. The ID of the item to update.string
updateProperties
object
. The properties to update. Accepts the same values ascreate()
.-
type
OptionalcontextMenus.ItemType
. The type of menu item: "normal", "checkbox", "radio", "separator". Defaults to "normal".title
Optionalstring
. The text to be displayed in the item; this is mandatory unlesstype
is "separator".checked
Optionalboolean
. The initial state of a checkbox or radio item:true
for selected andfalse
for unselected. Only one radio item can be selected at a time in a given group of radio items.contexts
Optionalarray
of
. Array of contexts in which this menu item will appear. Defaults to ['page'] if not specified.contextMenus.ContextType
onclick
Optionalfunction
. A function that will be called when the menu item is clicked. Event pages cannot use this: instead, they should register a listener forcontextMenus.onClicked
.parentId
Optional
orinteger
. The ID of a parent menu item; this makes the item a child of a previously added item. Note: You cannot change an item to be a child of one of its own descendants.string
documentUrlPatterns
Optionalarray
of
. 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.string
targetUrlPatterns
Optionalarray
of
. Similar tostring
documentUrlPatterns
, but lets you filter based on thesrc
attribute of img/audio/video tags and thehref
of anchor tags.enabled
Optionalboolean
. Whether this context menu item is enabled or disabled. Defaults totrue
.
callback
Optionalfunction
. Called when the context menu has been updated.
Browser compatibility
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.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | Yes | 48.0 | No | 33 |
Compatibility notes
Firefox
- documentUrlPatterns is supported from Firefox 50.
Examples
This example creates a context menu item, then updates its title when the user clicks it:
function onUpdated() { if (chrome.runtime.lastError) { console.log("error updating item:" + chrome.runtime.lastError); } else { console.log("item updated successfully"); } } chrome.contextMenus.create({ id: "do-not-click-me", title: "Do not click this button", contexts: ["all"] }); chrome.contextMenus.onClicked.addListener(function(info, tab) { if (info.menuItemId == "do-not-click-me") { chrome.contextMenus.update(info.menuItemId, { title: "Do not click this button again" }, onUpdated); } });
Example add-ons
This API is based on Chromium's chrome.contextMenus
API. This documentation is derived from context_menus.json
in the Chromium code.
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// 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.