Angular ContextMenu Properties

See Also

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

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.

Set this object to null or undefined to disable animation.

Use this property to customize the current menu in isolation from other menus created on the same page.

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:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  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.ts

  app.component.html

  app.module.ts

  import { 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.js

  import 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.

Set this property to the name of a data field that provides displayed values...

displayExpr: "name"

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

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.

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.

$(function () {
    $("#contextMenuContainer").dxContextMenu({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

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>

<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>

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>
    );
}

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.

See Also

• Customize Item Appearance
• Custom Templates

<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;
    }
}

<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>

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

The following example shows how to subscribe to component property changes:

$(function() {
    $("#contextMenuContainer").dxContextMenu({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<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 { }  

<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> 

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}
        />        
    ); 
} 

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
});

DataGrid Demo Navigation UI Demo Editors Demo

To enable selection, set this property to true and the selectionMode property to 'single'.

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".

If you assign only a string that specifies event names on which the UI component is shown, the UI component will not apply any delay.

showEvent: "mouseenter"

By default, the submenus of the context menu are displayed so that they are visible totally, based on the UI component location on the page. Use the submenuDirection property to display submenus to the left or to the right from the context menu.

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

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.js

  import 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.html

  app.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.js

  import 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.

Use this property to display/hide a context menu in code.

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.