Add items to the browser's context menu, to be displayed in the contexts you specify. For example, you can show the item only when the user clicks on an image, or on an editable element, or when part of a page is selected.
To use this API you need to have the "contextMenus" permission.
Types
contextMenus.ContextType- The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all contexts.
contextMenus.ItemType- The type of menu item.
contextMenus.OnClickData- Information sent when a context menu item is clicked.
Properties
contextMenus.ACTION_MENU_TOP_LEVEL_LIMIT- The maximum number of top level extension items that can be added to an extension action context menu. Any items beyond this limit will be ignored.
Functions
contextMenus.create()- Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in
runtime.lastError). contextMenus.update()- Updates a previously created context menu item.
contextMenus.remove()- Removes a context menu item.
contextMenus.removeAll()- Removes all context menu items added by this extension.
Events
contextMenus.onClicked- Fired when a context menu item is clicked.
Browser compatibility
| Edge | Firefox | Chrome | Opera | |
|---|---|---|---|---|
ACTION_MENU_TOP_LEVEL_LIMIT | ? | 45.0 | Yes | 33 |
ContextType | ? | 45.0 | Yes | 33 |
ItemType | ? | 45.0 | Yes | 33 |
OnClickData | ? | 45.0 | Yes | 33 |
create | ? | 45.0 | Yes | 33 |
onClicked | ? | 45.0 | Yes | 33 |
remove | ? | 45.0 | Yes | 33 |
removeAll | ? | 45.0 | Yes | 33 |
update | ? | 45.0 | Yes | 33 |
| Firefox | |
|---|---|
ACTION_MENU_TOP_LEVEL_LIMIT | No |
ContextType | No |
ItemType | No |
OnClickData | No |
create | No |
onClicked | No |
remove | No |
removeAll | No |
update | No |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
None.
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.
