Configuration

An object defining configuration options for the Menu 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.

adaptivityEnabled

Specifies whether adaptive widget rendering is enabled on small screens. Applies only if the orientation is "horizontal".

Type:

Boolean

Default Value: false

On small-screen devices, the Menu is shown as a list icon, and items have a tree structure like the TreeView items if adaptive rendering is enabled.

Watch Video

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

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

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

Razor C#
Razor VB
@(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" }
    })
)

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

Default Value: undefined

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

  • Number
    The height of the widget 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;
    }

hideSubmenuOnMouseLeave

Specifies whether or not the submenu is hidden when the mouse pointer leaves it.

Type:

Boolean

Default Value: false

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.

Type:

Array<dxMenuItemTemplate>

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 the name of the data source item field that contains an array of nested items.

Type:

String

|

Function

Default Value: 'items'

itemTemplate

Specifies a custom template for an item.

Type:

template

Function parameters:
itemData:

Object

The item object to be rendered.

itemIndex:

Number

The index of the item to be rendered.

itemElement:

jQuery

An HTML element of the item to be rendered.

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

Default Value: 'item'

If you use the Angular, AngularJS or Knockout library, you can implement this template with the dxTemplate markup component. This template's binding context depends on the library you use.

In Angular apps, an item's object and index extend the standard binding context (a component instance). Access the former using the input variable that is declared after the let and before of keywords, and the latter by the variable that is set to the index property.

In AngularJS apps, an item's object and index extend the standard binding context (the scope). Access the former using an alias that you specify in the dx-item-alias directive, and the latter the $index variable. Use AngularJS binding variables if you need to access another binding context from the template.

In Knockout apps, you can bind template elements directly to an item object's fields. Use the $index variable to get the item's index. Use Knockout binding variables if you need to access another binding context from the template.

See Also

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

model

Object

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

model

Object

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

Default Value: null

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

onItemClick

A handler for the itemClick event.

Type:

Function

|

String

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

itemData

Object

The data that is bound to the clicked item.

itemElement

jQuery

An HTML element of the item.

itemIndex

Number

Specifies the index of the clicked item.

jQueryEvent

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

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.

onItemContextMenu

A handler for the itemContextMenu event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

itemData

Object

The data that is bound to the item.

itemElement

jQuery

An HTML element of the item.

itemIndex

Number

Specifies the index of the item.

jQueryEvent

jQuery.Event

Specifies the jQuery event that caused action execution.

Default Value: null

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.

onItemRendered

A handler for the itemRendered event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data available for binding against the element. Available only in the Knockout approach.

itemData

Object

The data that is bound to the item to be rendered.

itemElement

jQuery

An HTML element of the item.

itemIndex

Number

Specifies the index of the rendered item.

Default Value: null

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

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

name

String

A short name of the option whose value has been changed.

fullName

String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value any

A new value for the option.

element

jQuery

The widget's container.

model

Object

The model data. Available only if you use Knockout.

Default Value: null

onSelectionChanged

A handler for the selectionChanged event. Raised after an item is selected or unselected.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

addedItems

Array

An array of items added to selection.

removedItems

Array

An array of items removed from selection.

Default Value: null

This option makes sense only if the selectionMode option is set to 'single' and the selectByClick option is set to true.

Assign a function to perform a custom action after a collection item is selected or unselected.

onSubmenuHidden

A handler for the submenuHidden event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem

jQuery

A jQuery object of the root menu element for which the submenu is hidden.

Default Value: null

onSubmenuHiding

A handler for the submenuHiding event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem

jQuery

A jQuery object of the root menu element for which the submenu is being hidden.

cancel

Boolean

Specifies whether or not to cancel the hiding of the widget.

Default Value: null

onSubmenuShowing

A handler for the submenuShowing event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem

jQuery

A jQuery object of the root menu element for which the submenu is being displayed.

Default Value: null

onSubmenuShown

A handler for the submenuShown event.

Type:

Function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
Name Type Description
component

Object

Provides access to the widget's instance.

element

jQuery

An HTML element of the widget.

model

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

rootItem

jQuery

A jQuery object of the root menu element for which the submenu is displayed.

Default Value: null

orientation

Specifies whether the menu has horizontal or vertical orientation.

Type:

String

Default Value: 'horizontal'
Accepted Values: 'horizontal' | 'vertical'

When using the widget as an ASP.NET MVC Control, specify this option using the Orientation enum. This enum accepts the following values: Horizontal and Vertical.

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

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

selectionByClick Deprecated

Use the selectByClick option instead.

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

Type:

Boolean

Default Value: false

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

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.

showFirstSubmenuMode

Specifies options for showing and hiding the first level submenu.

Type:

Object

|

String

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

If you assign a string that specifies the mode name to this option, the widget will use the default delay value.

JavaScript
showFirstSubmenuMode: "onHover"

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.

showSubmenuMode

Specifies options of submenu showing and hiding.

Type:

Object

|

String

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

By default, the secondary-level submenus of the Menu widget are displayed on the same event as the first-level submenu. To set another event for displaying secondary-level submenus, use the showSubmenuMode option. Alternatively, you can change the event on which the first-level submenu is displayed. For this purpose, use the showFirstSubmenuMode option.

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.

submenuDirection

Specifies the direction at which the submenus are displayed.

Type:

String

Default Value: 'auto'
Accepted Values: 'auto' | 'leftOrTop' | 'rightOrBottom'

By default, the first submenu is displayed so that it is visible totally, based on the menu location on the page. Use the submenuDirection option to display the first submenu at the bottom or at the top of a root item when the widget's orientation is horizontal, and to the left or to the right when orientation is vertical.

When using the widget as an ASP.NET MVC Control, specify this option using the SubmenuDirection enum. This enum accepts the following values: LeftOrTop, RightOrBottom 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.

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The widget width.

Default Value: undefined

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

  • Number
    The width of the widget 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;
    }