ContextMenu

The ContextMenu widget displays a single- or multi-level context menu. An end user invokes this menu by a right click or a long press.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/context_menu
ContextMenu interactive configuration
Copy Code
Copy to Codepen
$("#contextmenu").dxContextMenu({
});

                    

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

  • jQuery
    Use the dxContextMenu jQuery plug-in.

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

    HTML
    <div id="targetElement"></div>
    <div data-bind="dxContextMenu: {
        items: menuItems,
        target: '#targetElement'
    }"></div>
  • AngularJS
    Add a div element and apply the dx-context-menu directive to this element.

    HTML
    <div id="targetElement"></div>
    <div dx-context-menu="{
        items: menuItems,
        target: '#targetElement'
    }"></div>

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 Installation article.

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

View Demo

Configuration

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

alternativeInvocationMode

Holds an object that specifies options of alternative menu invocation.

animation

An object that defines the animation options of the widget.

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.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

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.

onDisposing

A handler for the disposing event.

onHidden

A handler for the hidden event.

onHiding

A handler for the hiding 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.

onPositioning

A handler for the positioning event.

onSelectionChanged

A handler for the selectionChanged event.

onShowing

A handler for the showing event.

onShown

A handler for the shown event.

position

An object defining widget positioning options.

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.

selectedItems

An array of currently selected item objects.

selectionMode

Specifies the selection mode supported by the menu.

showSubmenuMode

Specifies options of submenu showing and hiding.

submenuDirection

Specifies the direction at which submenus are displayed.

tabIndex

Specifies the widget tab index.

target

The target element associated with the context menu.

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.

hide()

Hides 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.

show()

Shows the widget.

toggle()

Toggles the visibility of the widget.

unselectItem(itemElement)

Unselects the specified item.

Events

This section describes events fired by this widget.

Name Description
contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

hidden

Fires when the context menu is hidden.

hiding

Fires before the context menu is hidden.

initialized

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

positioning

Fires before the context menu is positioned.

selectionChanged

Fires after a collection item is selected or unselected.

showing

Fires before the context menu is displayed.

shown

Fires when the context menu is displayed.

Default Item Template

This section lists the data source fields that are used in a default item template.

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