menus.OnClickData
Information passed to the menus.onClicked event listener when a menu item is clicked.
Type
Values of this type are objects. They contain the following properties:
-
bookmarkIdOptional -
string. The ID of the bookmark where the context menu was clicked. -
buttonOptional -
integer. Which mouse button was pressed. The values are the same as forMouseEvent.button. -
checkedOptional -
boolean. A flag indicating whether a checkbox or radio item was checked after it was clicked. editable-
boolean. A flag indicating whether the element is editable: for example, if it is a textarea. -
frameIdOptional -
integer. The ID of the frame in which the item was clicked. The frame ID can be used in other APIs that accept frame IDs, such astabs.sendMessage(). If the item was clicked in the top level document,frameIdis zero. If the item was clicked outside the page entirely (for example, in thetools_menuortabcontext), thenframeIdisundefined. -
frameUrlOptional -
string. The URL of the frame of the element where the context menu was clicked, if it was in a frame. -
linkTextOptional -
string. If the element is a link, the text for the link. If the link contains no text, the URL itself is given here. -
linkUrlOptional -
string. If the element is a link, the URL it points to. -
mediaTypeOptional -
string. One of "image", "video", or "audio" if the context menu was activated on one of these types of elements. menuItemId-
integerorstring. The ID of the menu item that was clicked. modifiers-
arrayofstring. An array containing any modifier keys that were pressed when the item was clicked. Possible values are: "Alt", "Command", "Ctrl", "MacCtrl", and "Shift". On a Mac, if the user has the Control key pressed, then both "Ctrl" and "MacCtrl" are included. -
pageUrlOptional -
string. The URL of the page in which the menu item was clicked. This property is not present if the click occurred in a context where there is no current page, such as on a browser action. -
parentMenuItemIdOptional -
integerorstring. The parent ID, if any, for the item clicked. -
selectionTextOptional -
string. If some text was selected in the page, this contains the selected text. -
srcUrlOptional -
string. Will be present for elements with a "src" URL. -
targetElementIdOptional -
integer. An identifier of the element, if any, over which the context menu was created. Usemenus.getTargetElement()in the content script to locate the element. Note that this is not the id attribute of the page element. -
viewTypeOptional -
ViewType. The type of extension view. -
wasCheckedOptional -
boolean. A flag indicating whether a checkbox or radio item was checked before it was clicked.
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
OnClickData |
Yes |
14 |
55
48
|
? |
Yes |
14 |
? |
? |
No |
? |
? |
? |
bookmarkId |
No |
No |
59 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
button |
No |
No |
64 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
frameId |
35 |
≤79 |
55 |
? |
Yes |
14 |
? |
? |
No |
? |
? |
? |
linkText |
No |
No |
56 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
modifiers |
No |
No |
54 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
targetElementId |
No |
No |
63 |
? |
No |
No |
? |
? |
No |
? |
? |
? |
Note: This API is based on Chromium's chrome.contextMenus API. This documentation is derived from context_menus.json in the Chromium code.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/menus/OnClickData