JavaScript/jQuery ContextMenu API
The ContextMenu widget displays a single- or multi-level context menu. An end user invokes this menu by a right click or a long press.
See Also
- Set Up DevExtreme: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Configuration
| Name | Description |
|---|---|
| accessKey |
Specifies the shortcut key that sets focus on the widget. |
| activeStateEnabled |
A Boolean value specifying whether or not the widget changes its state when interacting with a user. |
| animation |
Configures widget visibility animations. This object contains two fields: show and hide. |
| closeOnOutsideClick |
Specifies whether to close the ContextMenu if a user clicks outside it. |
| cssClass |
Specifies the name of the CSS class to be applied to the root menu level and all submenus. |
| dataSource |
Binds the widget to data. |
| disabled |
Specifies whether the widget responds to user interaction. |
| disabledExpr |
Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled. |
| displayExpr |
Specifies the data field whose values should be displayed. |
| elementAttr |
Specifies the attributes to be attached to the widget's root element. |
| focusStateEnabled |
Specifies whether the widget can be focused using keyboard navigation. |
| height |
Specifies the widget's height. |
| hint |
Specifies text for a hint that appears when a user pauses on the widget. |
| hoverStateEnabled |
Specifies whether the widget changes its state when a user pauses on it. |
| itemComponent |
An alias for the itemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information. |
| itemRender |
An alias for the itemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information. |
| items |
Holds an array of menu items. |
| itemsExpr |
Specifies which data field contains nested items. |
| itemTemplate |
Specifies a custom template for items. |
| onContentReady |
A function that is executed when the widget's content is ready and each time the content is changed. |
| onDisposing |
A function that is executed before the widget is disposed of. |
| onHidden |
A function that is executed after the ContextMenu is hidden. |
| onHiding |
A function that is executed before the ContextMenu is hidden. |
| onInitialized |
A function used in JavaScript frameworks to save the widget instance. |
| onItemClick |
A function that is executed when a collection item is clicked or tapped. |
| onItemContextMenu |
A function that is executed when a collection item is right-clicked or pressed. |
| onItemRendered |
A function that is executed after a collection item is rendered. |
| onOptionChanged |
A function that is executed after a widget option is changed. |
| onPositioning |
A function that is executed before the ContextMenu is positioned. |
| onSelectionChanged |
A function that is executed when a collection item is selected or selection is canceled. |
| onShowing |
A function that is executed before the ContextMenu is shown. |
| onShown |
A function that is executed after the ContextMenu is shown. |
| position |
An object defining widget positioning options. |
| rtlEnabled |
Switches the widget to a right-to-left representation. |
| selectByClick |
Specifies whether or not an item becomes selected if a user clicks it. |
| selectedExpr |
Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected. |
| selectedItem |
The selected item object. |
| selectionMode |
Specifies the selection mode supported by the menu. |
| showEvent |
Specifies options for displaying the widget. |
| showSubmenuMode |
Specifies options of submenu showing and hiding. |
| submenuDirection |
Specifies the direction at which submenus are displayed. |
| tabIndex |
Specifies the number of the element when the Tab key is used for navigating. |
| target |
The target element associated with the context menu. |
| visible |
A Boolean value specifying whether or not the widget is visible. |
| width |
Specifies the widget's width. |
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Methods
| Name | Description |
|---|---|
| beginUpdate() |
Prevents the widget from refreshing until the endUpdate() method is called. |
| defaultOptions(rule) |
Specifies the device-dependent default configuration options for this component. |
| dispose() |
Disposes of all the resources allocated to the ContextMenu instance. |
| element() |
Gets the root widget element. |
| endUpdate() |
Refreshes the widget after a call of the beginUpdate() method. |
| focus() |
Sets focus on the widget. |
| getDataSource() |
Gets the DataSource instance. |
| getInstance(element) |
Gets the instance of a widget found using its DOM node. |
| hide() |
Hides the widget. |
| instance() |
Gets the widget's instance. Use it to access other methods of the widget. |
| off(eventName) |
Detaches all event handlers from a single event. |
| off(eventName, eventHandler) |
Detaches a particular event handler from a single event. |
| on(eventName, eventHandler) |
Subscribes to an event. |
| on(events) |
Subscribes to events. |
| option() |
Gets all widget options. |
| option(optionName) |
Gets the value of a single option. |
| option(optionName, optionValue) |
Updates the value of a single option. |
| option(options) |
Updates the values of several options. |
| registerKeyHandler(key, handler) |
Registers a handler to be executed when a user presses a specific key. |
| repaint() |
Repaints the widget without reloading data. Call it to update the widget's markup. |
| selectItem(itemElement) |
Selects an item found using its DOM node. |
| show() |
Shows the widget. |
| toggle(showing) |
Shows or hides the widget depending on the argument. |
| unselectItem(itemElement) |
Cancels the selection of an item found using its DOM node. |
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Events
| Name | Description |
|---|---|
| contentReady |
Raised when the widget's content is ready. |
| disposing |
Raised before the widget is disposed of. |
| hidden |
Raised after the ContextMenu is hidden. |
| hiding |
Raised before the ContextMenu is hidden. |
| initialized |
Raised only once, after the widget is initialized. |
| itemClick |
Raised when a collection item is clicked or tapped. |
| itemContextMenu |
Raised when a collection item is right-clicked or pressed. |
| itemRendered |
Raised after a collection item is rendered. |
| optionChanged |
Raised after a widget option is changed. |
| positioning |
Raised before the ContextMenu is positioned. |
| selectionChanged |
Raised when a collection item is selected or selection is canceled. |
| showing |
Raised before the ContextMenu is shown. |
| shown |
Raised after the ContextMenu is shown. |
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
Default Item Template
By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.