JavaScript/jQuery Menu Options
An object defining configuration options for the Menu widget.
accessKey
Specifies the shortcut key that sets focus on the widget.
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.
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".
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.
animation
cssClass
Specifies the name of the CSS class to be applied to the root menu level and all submenus.
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.
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.
.
, ,
, :
, [
, 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.
disabledExpr
Specifies the name of the data source item field whose value defines whether or not the corresponding widget item is disabled.
displayExpr
Specifies the name of the data source item field whose value is displayed by the widget.
elementAttr
Specifies the attributes to be attached to the widget's root element.
jQuery
$(function(){ $("#menuContainer").dxMenu({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<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
@(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.
height
Specifies the widget's height.
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:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hideSubmenuOnMouseLeave
Specifies whether or not the submenu is hidden when the mouse pointer leaves it.
hint
Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled
Specifies whether the widget changes its state when a user pauses on it.
items
Holds an array of menu items.
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.
onContentReady
A function that is executed when the widget's content is ready and each time the content is changed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
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. |
onDisposing
A function that is executed before the widget is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
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. |
onInitialized
A function that is executed only once, after the widget is initialized.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
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.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. |
|
model |
The model data. Available only if you use Knockout. |
|
itemData |
The clicked item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The clicked item's index. |
|
jQueryEvent |
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. |
onItemContextMenu
A function that is executed when a collection item is right-clicked or pressed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
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. |
|
itemData |
The item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The item's index. |
|
jQueryEvent |
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. |
onItemRendered
A function that is executed after a collection item is rendered.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
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. |
|
itemData |
The current item's data. |
|
itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
itemIndex |
The current item's index. |
onOptionChanged
A function that is executed after a widget option is changed.
Information about the event.
Name | Type | Description |
---|---|---|
name |
The option's short name. |
|
model |
The model data. Available only if you use Knockout. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
fullName |
The option's full name. |
|
value | any |
The option's new value. |
onSelectionChanged
A function that is executed when a collection item is selected or the selection is canceled.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
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. |
|
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. |
See Also
onSubmenuHidden
A function that is executed after a submenu is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
rootItem |
The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery. |
onSubmenuHiding
A function that is executed before a submenu is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
rootItem |
The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery. |
|
cancel |
Allows you to cancel submenu hiding. |
onSubmenuShowing
A function that is executed before a submenu is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
rootItem |
The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery. |
onSubmenuShown
A function that is executed after a submenu is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
rootItem |
The container of the root menu element. It is an HTML Element or a jQuery Element when you use jQuery. |
orientation
Specifies whether the menu has horizontal or vertical orientation.
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
.
rtlEnabled
Switches the widget to a right-to-left representation.
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
selectByClick
Specifies whether or not an item becomes selected if a user clicks it.
selectedExpr
Specifies the name of the data source item field whose value defines whether or not the corresponding widget items is selected.
selectionMode
Specifies the selection mode supported by the menu.
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.
If you assign a string that specifies the mode name to this option, the widget will use the default delay value.
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
.
showSubmenuMode
Specifies options of submenu showing and hiding.
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.
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
.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this option will be passed to the tabindex
attribute of the HTML element that underlies the widget.
width
Specifies the widget's width.
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:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.