Menu
The Menu widget is a panel with clickable items. A click on an item opens a drop-down menu, which can contain several submenus.
You can create the widget using one of the following approaches.
-
HTMLJavaScript
<div id="menu"></div>
var menuItems = [ { text: "Hide" }, { text: "Delete" }, { text: "Clipboard", items: [ { text: "Copy text" }, { text: "Clear text" }, { text: "Paste text" } ] } ]; $(function () { $("#menu").dxMenu({ items: menuItems }); });
-
HTMLJavaScript
<dx-menu [items]="menuItems"></dx-menu>
export class AppComponent { menuItems = [ // ... ]; }
-
HTMLJavaScript
<div ng-controller="DemoController"> <div dx-menu="{ items: menuItems }"></div> </div>
angular.module('DemoApp', ['dx']) .controller("DemoController", function ($scope) { $scope.menuItems = [ // ... ]; });
-
HTMLJavaScript
<div data-bind="dxMenu: { items: menuItems }"></div>
var viewModel = { menuItems: [ // ... ] }; ko.applyBindings(viewModel);
-
Razor C#Razor VB
@(Html.DevExtreme().Menu() .ID("menu") .Items(items => { items.Add().Text("Hide"); items.Add().Text("Delete"); items.Add().Text("Clipboard").Items(clipboardItems => { clipboardItems.Add().Text("Copy text"); clipboardItems.Add().Text("Clear text"); clipboardItems.Add().Text("Paste text"); }); }) )
@(Html.DevExtreme().Menu() _ .ID("menu") _ .Items(Sub(items) items.Add().Text("Hide") items.Add().Text("Delete") items.Add().Text("Clipboard").Items(Sub(clipboardItems) clipboardItems.Add().Text("Copy text") clipboardItems.Add().Text("Clear text") clipboardItems.Add().Text("Paste text") End Sub) End Sub) )
Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.
See Also
Configuration
An object defining configuration options for the Menu widget.
Name | Description |
---|---|
accessKey | Specifies a shortcut key that sets focus on the widget element. |
activeStateEnabled | A Boolean value specifying whether or not the widget changes its state when interacting with a user. |
adaptivityEnabled | Specifies whether adaptive widget rendering is enabled on small screens. Applies only if the orientation is "horizontal". |
animation | Configures widget visibility animations. This object contains two fields: show and hide. |
cssClass | Specifies the name of the CSS class to be applied to the root menu level and all submenus. |
dataSource | A data source used to fetch data to be displayed by the widget. |
disabled | A Boolean value specifying whether or not the widget can respond to user interaction. |
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. |
focusStateEnabled | Specifies whether or not the widget can be focused. |
height | Specifies the height of the widget. |
hideSubmenuOnMouseLeave | Specifies whether or not the submenu is hidden when the mouse pointer leaves it. |
hint | Specifies the text of the hint displayed for the widget. |
hoverStateEnabled | A Boolean value specifying whether or not the widget changes its state when being hovered by an end user. |
items | Holds an array of menu items. |
itemsExpr | Specifies the name of the data source item field that contains an array of nested items. |
itemTemplate | The template to be used for rendering items. |
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. |
onDisposing | A handler for the disposing event. |
onInitialized | A handler for the initialized event. Executed only once, after the widget is initialized. |
onItemClick | A handler for the itemClick event. |
onItemContextMenu | A handler for the itemContextMenu event. |
onItemRendered | A handler for the itemRendered event. |
onOptionChanged | A handler for the optionChanged event. |
onSelectionChanged | A handler for the selectionChanged event. |
onSubmenuHidden | A handler for the submenuHidden event. |
onSubmenuHiding | A handler for the submenuHiding event. |
onSubmenuShowing | A handler for the submenuShowing event. |
onSubmenuShown | A handler for the submenuShown event. |
orientation | Specifies whether the menu has horizontal or vertical orientation. |
rtlEnabled | Specifies whether or not the current component supports a right-to-left representation. |
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. |
selectedItem | The selected item object. |
selectionMode | Specifies the selection mode supported by the menu. |
showFirstSubmenuMode | Specifies options for showing and hiding the first level submenu. |
showSubmenuMode | Specifies options of submenu showing and hiding. |
submenuDirection | Specifies the direction at which the submenus are displayed. |
tabIndex | Specifies the widget tab index. |
visible | A Boolean value specifying whether or not the widget is visible. |
width | Specifies the width of the widget. |
Methods
This section describes members used to manipulate the widget.
Name | Description |
---|---|
beginUpdate() | Prevents the component from refreshing until the endUpdate() method is called. |
defaultOptions(rule) | Specifies the device-dependent default configuration options for this component. |
element() | Returns the root HTML element of the widget. |
endUpdate() | Enables the component to refresh after the beginUpdate() method call. |
focus() | Sets focus on the widget. |
getDataSource() | Allows you to get the DataSource instance. |
instance() | Returns an instance of this component class. |
off(eventName) | Detaches all event handlers from the specified event. |
off(eventName, eventHandler) | Detaches a particular event handler from the specified event. |
on(eventName, eventHandler) | Subscribes to a specified event. |
on(events) | Subscribes to the specified events. |
option() | Returns the configuration options of this component. |
option(optionName) | Gets the value of the specified configuration option of this component. |
option(optionName, optionValue) | Sets a value to the specified configuration option of this component. |
option(options) | Sets one or more options of this component. |
registerKeyHandler(key, handler) | Registers a handler when a specified key is pressed. |
repaint() | Redraws the widget. |
selectItem(itemElement) | Selects the specified item. |
unselectItem(itemElement) | Cancels the selection of the specified item. |
Events
This section describes events fired by this widget.
Name | Description |
---|---|
contentReady | Raised when the widget's content is ready. |
disposing | Fires when the widget is being removed. |
initialized | Raised only once, after the widget is initialized. |
itemClick | Fires when a widget item is clicked. |
itemContextMenu | Fires 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. |
itemRendered | Fires after a collection item is rendered. |
optionChanged | Fires after an option of the component is changed. |
selectionChanged | Fires after a collection item is selected or unselected. |
submenuHidden | Fires when the submenu is hidden. |
submenuHiding | Fires before the submenu is hidden. |
submenuShowing | Fires before the submenu is displayed. |
submenuShown | Fires when the submenu is displayed. |
Default Item Template
This section lists the data source fields that are used in a default template for menu items.
By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.
We appreciate your feedback.