JavaScript/jQuery ContextMenu Options
See Also
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
activeStateEnabled
The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.
Use this property when you display the component on a platform whose guidelines include the active state change for UI components.
animation
closeOnOutsideClick
Use the hideOnOutsideClick property instead.
Event (jQuery or EventObject)
The event that caused UI component closing. It is a EventObject or a jQuery.Event when you use jQuery.
dataSource
The ContextMenu works with collections of string
values or objects.
Depending on your data source, bind ContextMenu to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.
Data Array
Assign the array to the dataSource option.Read-Only Data in JSON Format
Set the dataSource property to the URL of a JSON file or service that returns JSON data.OData
Implement an ODataStore.Web API, PHP, MongoDB
Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.
jQuery
JavaScript$(function() { let serviceUrl = "https://url/to/my/service"; $("#contextMenuContainer").dxContextMenu({ // ... dataSource: DevExpress.data.AspNet.createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) }) });
Angular
app.component.tsapp.component.htmlapp.module.tsimport { Component } from '@angular/core'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { store: CustomStore; constructor() { let serviceUrl = "https://url/to/my/service"; this.store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }) } }
<dx-context-menu ... [dataSource]="store"> </dx-context-menu>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxContextMenuModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxContextMenuModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
Vue
App.vue<template> <DxContextMenu ... :data-source="store" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import { DxContextMenu } from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, data() { const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); return { store } } } </script>
React
App.jsimport React from 'react'; import 'devextreme/dist/css/dx.light.css'; import CustomStore from 'devextreme/data/custom_store'; import { createStore } from 'devextreme-aspnet-data-nojquery'; import ContextMenu from 'devextreme-react/context-menu'; const serviceUrl = "https://url/to/my/service"; const store = createStore({ key: "ID", loadUrl: serviceUrl + "/GetAction", insertUrl: serviceUrl + "/InsertAction", updateUrl: serviceUrl + "/UpdateAction", deleteUrl: serviceUrl + "/DeleteAction" }); class App extends React.Component { render() { return ( <ContextMenu ... dataSource={store} /> ); } } export default App;
Any other data source
Implement a CustomStore.
Regardless of the data source on the input, the ContextMenu always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.
Review the following notes about data binding:
Do not specify the items property if you specified the dataSource, and vice versa.
Data field names cannot be equal to
this
and should not contain the following characters:.
,:
,[
, and]
.
jQuery
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.
Angular
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
Vue
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.
React
- The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.
disabledExpr
Specifies the name of the data source item field whose value defines whether or not the corresponding UI component item is disabled.
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#contextMenuContainer").dxContextMenu({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-context-menu ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-context-menu>
import { DxContextMenuModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxContextMenuModule ], // ... })
Vue
<template> <DxContextMenu ... :element-attr="contextMenuAttributes"> </DxContextMenu> </template> <script> import DxContextMenu from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, data() { return { contextMenuAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import ContextMenu from 'devextreme-react/context-menu'; class App extends React.Component { contextMenuAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <ContextMenu ... elementAttr={this.contextMenuAttributes}> </ContextMenu> ); } } export default App;
height
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"20vh"
,"80%"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
hideOnOutsideClick
Event (jQuery or EventObject)
The event that caused UI component hiding. It is a EventObject or a jQuery.Event when you use jQuery.
The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.
jQuery
$(function () { $("#contextMenuContainer").dxContextMenu({ // ... hideOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
import { DxContextMenuModule } from "devextreme-angular"; // ... export class AppComponent { // ... hideOnOutsideClick(e) { return e.target === document.getElementById("someElement"); } } @NgModule({ imports: [ // ... DxContextMenuModule ], // ... })
<dx-context-menu ... [hideOnOutsideClick]="hideOnOutsideClick"> </dx-context-menu>
Vue
<template> <DxContextMenu .... :hide-on-outside-click="hideOnOutsideClick"> </DxContextMenu> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxContextMenu from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, methods: { hideOnOutsideClick (e) { return e.target === document.getElementById("someElement"); } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ContextMenu from 'devextreme-react/context-menu'; const hideOnOutsideClick = (e) => { return e.target === document.getElementById("someElement"); }; export default function App() { return ( <ContextMenu ... hideOnOutsideClick={hideOnOutsideClick}> </ContextMenu> ); }
items[]
The items array can contain:
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the itemTemplate.
If you need to update the UI component items, reassign the entire items array as shown in the following example:
contextMenuInstance.option('items', newItems);
As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.
onContentReady
A function that is executed when the UI component is rendered and each time the component is repainted.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onDisposing
A function that is executed before the UI component is disposed of.
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onHidden
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onHiding
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel UI component hiding. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onInitialized
Name | Type | Description |
---|---|---|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
Angular
<dx-context-menu ... (onInitialized)="saveInstance($event)"> </dx-context-menu>
import { Component } from "@angular/core"; import ContextMenu from "devextreme/ui/data_grid"; // ... export class AppComponent { contextMenuInstance: ContextMenu; saveInstance (e) { this.contextMenuInstance = e.component; } }
Vue
<template> <div> <DxContextMenu ... @initialized="saveInstance"> </DxContextMenu> </div> </template> <script> import DxContextMenu from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, data: function() { return { contextMenuInstance: null }; }, methods: { saveInstance: function(e) { this.contextMenuInstance = e.component; } } }; </script>
<template> <div> <DxContextMenu ... @initialized="saveInstance"> </DxContextMenu> </div> </template> <script setup> import DxContextMenu from 'devextreme-vue/context-menu'; let contextMenuInstance = null; const saveInstance = (e) => { contextMenuInstance = e.component; } </script>
React
import ContextMenu from 'devextreme-react/context-menu'; class App extends React.Component { constructor(props) { super(props); this.saveInstance = this.saveInstance.bind(this); } saveInstance(e) { this.contextMenuInstance = e.component; } render() { return ( <div> <ContextMenu onInitialized={this.saveInstance} /> </div> ); } }
See Also
onItemClick
Name | Type | Description |
---|---|---|
itemIndex |
The clicked item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The clicked item's data. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. |
|
component |
The UI component's instance. |
onItemContextMenu
Name | Type | Description |
---|---|---|
itemIndex |
The item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The item's data. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onItemRendered
Name | Type | Description |
---|---|---|
itemIndex |
The current item's index. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemData |
The current item's data. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
onOptionChanged
Name | Type | Description |
---|---|---|
value | any |
The modified property's new value. |
previousValue | any |
The UI component's previous value. |
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#contextMenuContainer").dxContextMenu({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-context-menu ... (onOptionChanged)="handlePropertyChange($event)"> </dx-context-menu>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxContextMenuModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxContextMenuModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxContextMenu ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxContextMenu from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import ContextMenu from 'devextreme-react/context-menu'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <ContextMenu ... onOptionChanged={handlePropertyChange} /> ); }
onPositioning
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
event | Event (jQuery or EventObject) |
The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery. |
position |
onSelectionChanged
Name | Type | Description |
---|---|---|
removedItems | Array<any> |
The data of the items removed from selection. |
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
addedItems | Array<any> |
The data of the selected items. |
onShowing
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel UI component showing. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onShown
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
position
An object defining UI component positioning properties.
rtlEnabled
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
selectByClick
To enable selection, set this property to true
and the selectionMode property to 'single'
.
selectedExpr
Specifies the name of the data source item field whose value defines whether or not the corresponding UI component items is selected.
selectionMode
To select an item on click and to visually display the selection, set the selectByClick property to true. Note that in this case the selectionMode should be "single".
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
target
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
jQuery
index.js$(function(){ $("#contextMenuContainer").dxContextMenu({ // ... target: '#targetElement' }); });
Angular
app.component.html<dx-context-menu ... target="#targetElement" > </dx-context-menu>
Vue
App.vue<template> <DxContextMenu ... target="#targetElement" > </DxContextMenu> </template> <script> import { DxContextMenu } from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu } }; </script>
React
App.jsimport ContextMenu from 'devextreme-react/context-menu'; // ... function App() { return ( <ContextMenu ... target="#targetElement" > </ContextMenu> ); }
A jQuery wrapper
jQuery
index.js$(function(){ $("#contextMenuContainer").dxContextMenu({ // ... target: $('#targetElement') }); });
A DOM element
jQuery
index.js$(function(){ $("#contextMenuContainer").dxContextMenu({ // ... target: document.getElementById('#targetElement') }); });
Angular
app.component.htmlapp.component.ts<dx-context-menu ... [target]="targetElement" > </dx-context-menu>
// ... export class AppComponent { targetElement: Element; constructor() { this.targetElement = document.getElementById('#targetElement') as Element; } }
Vue
App.vue<template> <DxContextMenu ... :target="targetElement" > </DxContextMenu> </template> <script> import { DxContextMenu } from 'devextreme-vue/context-menu'; export default { components: { DxContextMenu }, data() { return { targetElement: null } }, mounted() { this.targetElement = document.getElementById('targetElement'); } }; </script>
React
App.jsimport React, { useEffect, useState } from 'react'; import ContextMenu from 'devextreme-react/context-menu'; // ... function App() { const [targetElement, setTargetElement] = useState(null); useEffect(() => { setTargetElement(document.getElementById('targetElement')); }, []); return ( <ContextMenu ... target={targetElement} > </ContextMenu> ); }
To align the ContextMenu against this element, use the position property.
width
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"20vw"
,"80%"
,"auto"
,"inherit"
.Function (deprecated since v21.2)
Refer to the W0017 warning description for information on how you can migrate to viewport units.
If you have technical questions, please create a support ticket in the DevExpress Support Center.