Configuration

An object defining configuration options for the ContextMenu widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

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

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: true

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

animation

Configures widget visibility animations. This object contains two fields: show and hide.

Type:

Object

Default Value: { show: { type: 'fade', from: 0, to: 1, duration: 100 }, hide: { type: 'fade', from: 1, to: 0, duration: 100 } }

closeOnOutsideClick

Specifies whether to close the ContextMenu if a user clicks outside it.

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or dxEvent)

The event that caused widget closing. It is a dxEvent or a jQuery.Event when you use jQuery.

Return Value:

Boolean

true if the widget should be closed; otherwise false.

Default Value: true

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.

jQuery
JavaScript
$(function () {
    $("#contextMenuContainer").dxContextMenu({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
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>

cssClass

Specifies the name of the CSS class to be applied to the root menu level and all submenus.

Type:

String

Default Value: ''

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

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

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.

NOTE
Data field names should not contain the following characters: ., ,, :, [, and ]. Their presence may cause issues in the widget's operation.

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.

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

disabledExpr

Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled.

Type:

String

|

Function

Default Value: 'disabled'

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

Type:

String

|

Function

Default Value: 'text'

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type:

Object

Default Value: {}
jQuery
$(function(){
    $("#contextMenuContainer").dxContextMenu({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
HTML
TypeScript
<dx-context-menu ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-context-menu>
import { DxContextMenuModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxContextMenuModule
    ],
    // ...
})
ASP.NET MVC Control
Razor C#
Razor VB
@(Html.DevExtreme().ContextMenu()
    .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().ContextMenu() _
    .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" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false, true (desktop)

height

Specifies the widget's height.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's height.

Default Value: undefined

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

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: true

items

Holds an array of menu items.

Raised Events: optionChanged

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.

NOTE
Each item of the array passed to the items option can include the items field, which takes on an object with the same structure as a root item. Therefore, you can create as many menu levels as you need.

itemsExpr

Specifies which data field contains nested items.

Type:

String

|

Function

Default Value: 'items'

itemTemplate

Specifies a custom template for items.

Type:

template

Function parameters:
itemData:

Object

The item object to be rendered.

itemIndex:

Number

The index of the item to be rendered.

itemElement:

Element (jQuery or HTML)

The container of the item to be rendered. It is an HTML Element or a jQuery Element when you use jQuery.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'item'

onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A function that is executed before the widget is disposed of.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onHidden

A function that is executed after the ContextMenu is hidden.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onHiding

A function that is executed before the ContextMenu is hidden.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

cancel:

Boolean

Allows you to cancel widget hiding.

Default Value: null

onInitialized

A function that is executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

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

onItemClick

A function that is executed when a collection item is clicked or tapped.

Type:

Function

|

String

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

itemData:

Object

The clicked item's data.

itemElement:

Element (jQuery or HTML)

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex:

Number

The clicked item's index.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

itemData:

Object

The item's data.

itemElement:

Element (jQuery or HTML)

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex:

Number

The item's index.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

Default Value: null

onItemRendered

A function that is executed after a collection item is rendered.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

itemData:

Object

The current item's data.

itemElement:

Element (jQuery or HTML)

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

itemIndex:

Number

The current item's index.

Default Value: null

onOptionChanged

A function that is executed after a widget option is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onPositioning

A function that is executed before the ContextMenu is positioned.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

jQueryEvent:

jQuery.Event

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

position:

positionConfig

Default Value: null

onSelectionChanged

A function that is executed when a collection item is selected or the selection is canceled.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

addedItems:

Array<any>

The data of the items that have been selected.

removedItems:

Array<any>

The data of the items whose selection has been canceled.

Default Value: null

onShowing

A function that is executed before the ContextMenu is shown.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

cancel:

Boolean

Allows you to cancel widget showing.

Default Value: null

onShown

A function that is executed after the ContextMenu is shown.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

ContextMenu

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

position

An object defining widget positioning options.

Default Value: { my: 'top left', at: 'top left' }
NOTE
By default, the context menu is positioned against the cursor, but if you set the position option, the widget will be positioned against the target element. Note also that the position.of option is always ignored in favor of the target option.

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

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.

JavaScript
DevExpress.config({
    rtlEnabled: true
});
See Also

selectByClick

Specifies whether or not an item becomes selected if a user clicks it.

Type:

Boolean

Default Value: false

selectedExpr

Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected.

Type:

String

|

Function

Default Value: 'selected'

selectedItem

The selected item object.

Type:

Object

Default Value: null
Raised Events: selectionChanged

selectionMode

Specifies the selection mode supported by the menu.

Type:

String

Default Value: none
Accepted Values: 'none' | 'single'

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

Use the MenuSelectionMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Single and None.

showEvent

Specifies options for displaying the widget.

Type:

Object

|

String

Default Value: 'dxcontextmenu'

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

JavaScript
showEvent: "dxclick"

showSubmenuMode

Specifies options of submenu showing and hiding.

Type:

Object

|

String

Default Value: { name: 'onHover', delay: { show: 0, hide: 0 } }
Accepted Values: 'onClick' | 'onHover'

Use the ShowSubmenuMode enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: OnHover and OnClick.

submenuDirection

Specifies the direction at which submenus are displayed.

Type:

String

Default Value: 'auto'
Accepted Values: 'auto' | 'left' | 'right'

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.

Use the ContextMenuSubmenuDirection enum to specify this option when the widget is used as an ASP.NET MVC Control. This enum accepts the following values: Left, Right, and Auto.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

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

target

The target element associated with the context menu.

Type:

String

|

DOM Node

|

jQuery

Default Value: undefined

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.

visible

A Boolean value specifying whether or not the widget is visible.

Type:

Boolean

Default Value: false
Raised Events: showing, hiding

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

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget's width.

Default Value: undefined

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