Angular Menu Properties

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:

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:

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:

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:

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.

Type:

|

Array<String | template>

|

DataSource

|

DataSource Configuration

Default Value: null

This option accepts one of the following.

Array of objects
A simple JavaScript array containing a collection of plain objects.
URL
The URL of a JSON file or service that returns JSON data.
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:

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:

|

Default Value: 'disabled'

displayExpr

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

Type:

|

Default Value: 'text'

elementAttr

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

Type:

Default Value: {}

jQuery

$(function(){
    $("#menuContainer").dxMenu({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-menu ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-menu>

import { DxMenuModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxMenuModule
    ],
    // ...
})

ASP.NET MVC Control

Razor C#

Razor VB

@(Html.DevExtreme().Menu()
    .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().Menu() _
    .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:

Default Value: true (desktop)

height

Specifies the widget's height.

Type:

|

|

Return Value:

|

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

hideSubmenuOnMouseLeave

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

Type:

Default Value: false

hint

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

Type:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: true

items

Holds an array of menu items.

Type:

Array<dxMenuItemTemplate>

Raised Events: onOptionChanged

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:

|

Default Value: 'items'

itemTemplate

Specifies a custom template for items.

Type:

template

Template Data:

The item object to be rendered.

Default Name: 'item'

onContentReady

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Menu

The widget's instance.

element

HTMLElement | jQuery

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

model

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

e:

Information about the event.

Object structure:

Name

Type

Description

component

Menu

The widget's instance.

element

HTMLElement | jQuery

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

model

The model data. Available only if you use Knockout.

Default Value: null

onInitialized

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

Menu

The widget's instance.

element

HTMLElement | jQuery

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

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	The widget's container.
model	Object	The model data. Available only if you use Knockout.
itemData	Object	The clicked item's data.
itemElement	HTMLElement \| jQuery	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	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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	HTMLElement \| jQuery	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	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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	HTMLElement \| jQuery	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 parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Menu	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Default Value: null

onSelectionChanged

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

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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

onSubmenuHidden

A function that is executed after a submenu is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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 Knockout is used.
rootItem	HTMLElement \| jQuery	The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onSubmenuHiding

A function that is executed before a submenu is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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 Knockout is used.
rootItem	HTMLElement \| jQuery	The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery.
cancel	Boolean	Allows you to cancel submenu hiding.

Default Value: null

onSubmenuShowing

A function that is executed before a submenu is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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 Knockout is used.
rootItem	HTMLElement \| jQuery	The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

onSubmenuShown

A function that is executed after a submenu is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Menu	The widget's instance.
element	HTMLElement \| jQuery	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 Knockout is used.
rootItem	HTMLElement \| jQuery	The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

orientation

Specifies whether the menu has horizontal or vertical orientation.

Type:

Default Value: 'horizontal'

Accepted Values: 'horizontal' | 'vertical'

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

View Demo

rtlEnabled

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

Type:

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:

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:

|

Default Value: 'selected'

selectedItem

The selected item object.

Type:

Default Value: null

Raised Events: onSelectionChanged

selectionMode

Specifies the selection mode supported by the menu.

Type:

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.

showFirstSubmenuMode

Specifies options for showing and hiding the first level submenu.

Type:

|

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"

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.

View Demo

showSubmenuMode

Specifies options of submenu showing and hiding.

Type:

|

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.

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 the submenus are displayed.

Type:

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.

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

View Demo

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: