React ContextMenu Props

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

The function passed to this option enables you to specify a custom condition for closing the widget. For instance, you can prevent closing until a user clicks a certain element.

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

import { DxContextMenuModule } from 'devextreme-angular';
// ...
export class AppComponent {
    // ...
    closeOnOutsideClick (e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxContextMenuModule
     ],
     // ...
 })

<dx-context-menu ...
    (closeOnOutsideClick)="closeOnOutsideClick($event)">
</dx-context-menu>

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

This option accepts one of the following.

• Array of objects
  A simple JavaScript array containing a collection of plain objects.

• URL
  A URL to JSON data or to a service returning data in JSON format.

• DataSource or its configuration object
  A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API.

You can configure this option in an ASP.NET MVC Control as follows:

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

This option accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

• Function
  A function returning either of the above. For example:

  JavaScript

  height: function() {
      return window.innerHeight / 1.5;
  }

To display menu items, a default template can be used. This template is based on certain fields of the item object. Refer to the Default Item Template section to learn which fields are taken into account when creating a default template for items. Alternatively, you can implement a custom item template.

See Also

• Customize Item Appearance
• Custom Templates

You cannot access widget elements in this handler because it is executed before they are ready. Use the onContentReady handler instead.

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

Assign a function to perform a custom action when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

Assign a function to perform a custom action after a collection item is rendered.

See Also

• selectionMode
• selectByClick

When this option is set to true, the widget 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
});

See Also

• Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors

To select an item on click and to visually display the selection, set the selectByClick option to true. Note that in this case the selectionMode should be 'single'.

When using the widget as an ASP.NET MVC Control, specify this option using the MenuSelectionMode enum. This enum accepts the following values: Single and None.

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

showEvent: 'dxclick'

When using the widget as an ASP.NET MVC Control, you can specify this option using the ShowSubmenuMode enum. This enum accepts the following values: OnHover and OnClick.

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

When using the widget as an ASP.NET MVC Control, specify this option using the ContextMenuSubmenuDirection enum. This enum accepts the following values: Left, Right and Auto.

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

This option accepts one of the following values.

• A CSS selector, or a jQuery selector if you use jQuery

  target: '#targetElement';

• A jQuery wrapper

  target: $('#targetElement');

• A DOM element

  target: document.getElementById('#targetElement');

To align the ContextMenu against this element, use the position option.

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

This option accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

• Function
  A function returning either of the above. For example:

  JavaScript

  width: function() {
      return window.innerWidth / 1.5;
  }