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:
bookmarkId
Optional-
string
. The ID of the bookmark where the context menu was clicked. -
integer
. Which mouse button was pressed. The values are the same as forMouseEvent.button
. checked
Optional-
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. frameId
Optional-
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,frameId
is zero. If the item was clicked outside the page entirely (for example, in thetools_menu
ortab
context), thenframeId
isundefined
. frameUrl
Optional-
string
. The URL of the frame of the element where the context menu was clicked, if it was in a frame. linkText
Optional-
string
. If the element is a link, the text for the link. If the link contains no text, the URL itself is given here. linkUrl
Optional-
string
. If the element is a link, the URL it points to. mediaType
Optional-
string
. One of "image", "video", or "audio" if the context menu was activated on one of these types of elements. -
integer
orstring
. The ID of the menu item that was clicked. modifiers
-
array
ofstring
. 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. pageUrl
Optional-
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. -
integer
orstring
. The parent ID, if any, for the item clicked. selectionText
Optional-
string
. If some text was selected in the page, this contains the selected text. srcUrl
Optional-
string
. If present, thesrc
value for the media in the clicked element. targetElementId
Optional-
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. viewType
Optional-
ViewType
. The type of extension view. wasChecked
Optional-
boolean
. A flag indicating whether a checkbox or radio item was checked before it was clicked.
Browser compatibility
BCD tables only load in the browser
Note: This API is based on Chromium's chrome.contextMenus
API. This documentation is derived from context_menus.json
in the Chromium code.