Menu

A menu widget.

Included in: dx.webappjs.js, dx.all.js

The dxMenu widget displays a single-level or multi-level menu that performs an action when an item is clicked.

You can create a widget using one of the following approaches.

  • jQuery
    Use the dxMenu jQuery plug-in.

    HTML
    <div id="menu"></div>
    JavaScript
    var menuItems = [
        { text: "Hide" },
        { text: "Delete" },
        {
            text: "Clipboard",
            items: [
                { text: "Copy text" },
                { text: "Clear text" },
                { text: "Paste text" }
            ]
        }
    ];
    $("#menu").dxMenu({
        items: menuItems
    });
  • Knockout
    Add a div element and apply the dxMenu binding to this element.

    HTML
    <div data-bind="dxMenu: {
        items: menuItems
    }"></div>
  • Angular
    Add a div element and apply the dx-menu directive to this element.

    HTML
    <div dx-menu="{
        items: menuItems
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

You can find detailed information on the principles of working with the widget in the dxMenu section of the Menu Widgets article.

View Demo

Watch Video

Configuration

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

animation

An object that defines the animation options of the widget.

cssClass

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

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.

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.

itemTemplate

The template to be used for rendering items.

onContentReady

A handler for the contentReady event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

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.

selectedItem

The selected item object.

selectionByClick

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

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.

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)

Unselects the specified item.

Events

This section describes events exposed by this widget.

Name Description
contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

itemClick

Fires when a widget item is clicked.

itemContextMenu

Fires when the 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