Configuration

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

allowSelection

Specifies whether or not a user can select a menu item.

Type: Boolean
Default Value: true

allowSelectItem

Deprecated

Use the allowSelection option instead.

Specifies whether or not a user can select a menu item.

Type: Boolean
Default Value: true

allowSelectOnClick

Specifies whether or not a user can select an item by clicking on it.

Type: Boolean
Default Value: false

animation

An object that defines submenu animation options.

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

contentReadyAction

An action performed when widget content is ready.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
Default Value: null

Assign a function to perform a custom action when widget content is ready.

Alternatively, you can assign a URL to which the browser will navigate when widget content is ready.

If data displayed by the widget is specified using a DataSource instance, the contentReadyAction is executed each time the load() method of the DataSource instance is called as well as when widget content is ready. In this case, when you create the widget, the contentReadyAction is executed twice: when widget content is ready (at this moment, the widget does not display items) and when the DataSource is loaded (the widget displays the loaded items).

Show Example:
jQuery

cssClass

Specifies the name of the CSS class associated with the menu.

Type: String
Default Value: ''

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

Show Example:
jQuery

dataSource

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

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

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. Alternatively, you can implement a custom item template. For details refer to the Customize Widget Item Appearance topic.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
jQuery

firstSubMenuDirection

Deprecated

Use the submenuDirection option instead.

Specifies the direction at which the first level submenu is displayed.

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

height

Specifies the height of the widget.

Type: Number|String|function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget height in pixels.
  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget height. For example, see the following code.

    JavaScript
    height: function () { 
        return baseHeight - 10 + "%";
    }

hoverStateEnabled

A Boolean value specifying whether or not a menu item changes its state when being hovered by an end user.

Type: Boolean
Default Value: false

itemClickAction

An action performed when a collection item is clicked.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
itemData: Object
The data that is bound to the clicked item.
itemElement: jQuery
An HTML element of the item.
Default Value: null

Assign a function to perform a custom action when the widget's collection item is clicked.

Alternatively, you can assign a URL to which the browser will navigate when the item is clicked.

Show Example:
jQuery

itemRender

A function used to render collection items.

Type: function
Function parameters:
itemData: Object
An object representing the item to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element containing the item to be rendered.
Return Value: String|DOM Node|jQuery
An HTML string, Element, or jQuery object representing the rendered item.
Default Value: null

As in all container widgets in DevExtreme, items of this widget are displayed by a default HTML template. This template is based on certain fields of the data source. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

Implement the itemRender function to provide a custom item template for a given collection item. This function is called each time a collection item of the widget is rendered.

Return an HTML string, Element, or jQuery object representing the rendered item.

Alternatively, you can define the dxTemplate markup component within the widget element and set its name option to item. In this case, the markup enclosed into the dxTemplate component will be automatically applied as an item template. In addition, you may need to define several item templates and apply each of them when required. In this instance, use the itemTemplate option to set the required template.

Refer to the Customize Widget Item Appearance topic to learn more about ways to render collection items.

itemRenderedAction

An action performed after a collection item is rendered.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
itemData: Object
The data that is bound to the rendered item.
itemElement: jQuery
An HTML element of the item.
Default Value: null

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

Alternatively, you can assign a URL to which the browser will navigate after a collection item is rendered.

items

Holds an array of menu items.

Type: Array

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. For details refer to the Customize Widget Item Appearance topic.

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.

Show Example:
jQuery

itemSelectAction

An action performed when a menu item is selected.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
selectedItem: Object
The data that is bound to the selected item.
previousSelectedItem: Object
The data that is bound to the previously selected item.
itemData: Object
The data that is bound to the selected item.
itemElement: jQuery
An HTML element of the item.
Default Value: null

Assign a function to perform a custom action when a menu item is selected.

Alternatively, you can assign a URL to which the browser will navigate when a menu item is selected.

Show Example:
jQuery

itemTemplate

The template to be used for rendering items.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.
Default Value: "item"

As in all container widgets in DevExtreme, items of this widget are displayed by a default HTML template. This template is based on specific data source fields. You can define a custom item template that will use specific fields of the data source. To learn more about item templates, refer to the Customize Widget Item Appearance topic.

In a simple case, you can define a single custom template for widget items using the dxTemplate markup component within the widget's container. Set the name option of this component to 'item'. In this instance, this template will automatically be used as an item template, and you don't have to specify the itemTemplate option.

However, in some cases you may need to have several custom item templates defined within the widget's container and apply each of them in different scenarios. In this instance, use one of the following ways of setting the required template to the itemTemplate option.

  • Assign a string representing the name of the required template.
  • Assign a function that returns the name of the template as a result of a certain logic.

When you have several collection widgets, you may need to define a common template for them. For this purpose, factor out a template into a separate element, as demonstrated below.

HTML
<script type="text/html" id="person-template">
    <h3 data-bind="text: name"></h3>
    <p>Address: <span data-bind="text: address"></span></p>
</script>

To set the common template as a collection item template, assign one of the following values to the itemTemplate option.

  • Assign a jQuery object representing the template's container
  • Assign a DOM Node representing the template's container
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container

You can use a custom template engine. For this purpose, call the DevExpress.ui.setTemplateEngine(name) method passing the name of one of the supported template engine. You can see a demo where a custom template engine is used: Data Grid - Row Underscore Template.

orientation

Specifies whether the menu has horizontal or vertical orientation.

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

Show Example:
jQuery

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

Show Example:
jQuery

selectedItem

Holds an object representing the currently selected menu item.

Type: Object
Default Value: false

Show Example:
jQuery

showFirstSubmenuMode

Specifies by which user interaction the first-level submenu is shown.

Type: String
Default Value: 'onclick'
Accepted Values: 'onhover'|'onHoverStay'|'onclick'

To set an event for displaying the secondary-level submenus, use the showSubmenuMode option.

Show Example:
jQuery

showPopupMode

Deprecated

Use the showFirstSubmenuMode option instead.

Specifies by which user interaction submenus are shown.

Type: String
Default Value: 'onclick'
Accepted Values: 'onhover'|'onHoverStay'|'onclick'

showSubmenuMode

Specifies by which user interaction secondary-level submenus are shown.

Type: String
Default Value: 'auto'
Accepted Values: 'onhover'|'onHoverStay'|'onclick' | 'auto'

By default, the secondary-level submenus of the dxMenu 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.

Show Example:
jQuery

submenuDirection

Specifies the direction at which the submenus are displayed.

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

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.

submenuHiddenAction

An action performed when a submenu is hidden.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
rootItem: jQuery
Returns an HTML element representing the widget item that is root for those items for which the current submenu is shown.
Default Value: false

Assign a function to perform a custom action when a submenu is hidden.

Alternatively, you can assign a URL to which the browser will navigate when a submenu is hidden.

Show Example:
jQuery

submenuHidingAction

An action performed before a submenu is hidden.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
rootItem: jQuery
Returns an HTML element representing the widget item that is root for those items for which the current submenu is shown.
cancel: Boolean
Indicates whether to cancel hiding the submenu.
Default Value: false

Assign a function to perform a custom action before a submenu is hidden.

Alternatively, you can assign a URL to which the browser will navigate before a submenu is hidden.

Show Example:
jQuery

submenuShowingAction

An action performed when a submenu is shown.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
rootItem: jQuery
Returns an HTML element representing the widget item that is root for those items for which the current submenu is shown.
Default Value: false

Assign a function to perform a custom action when a submenu is shown.

Alternatively, you can assign a URL to which the browser will navigate when a submenu is shown.

Show Example:
jQuery

submenuShownAction

An action performed before a submenu is shown.

Type: String|function(e)
Function parameters:
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element.
rootItem: jQuery
Returns an HTML element representing the widget item that is root for those items for which the current submenu is shown.
Default Value: false

Assign a function to perform a custom action before a submenu is shown.

Alternatively, you can assign a URL to which the browser will navigate before a submenu is shown.

Show Example:
jQuery

visible

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

Type: Boolean
Default Value: true

Show Example:
jQuery

width

Specifies the width of the widget.

Type: Number|String|function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }