JavaScript/jQuery ContextMenu - items

The items array can contain:

• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

contextMenuInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

You can add group separators only between items in submenus.

This property accepts one of the following:

• The icon's URL
• The icon's name if the icon is from the DevExtreme icon library
• The icon's CSS class if the icon is from an external icon library (see External Icon Libraries)
• The icon in the Base64 format
• The icon in the SVG format. Ensure that the source is reliable.

Nested menu items should have the same structure as the first-level menu items.

The following types of the specified value are available.

• Assign a string containing the name of the required template.
• Assign a jQuery object of the template's container.
• Assign a DOM Node of the template's container.
• Assign a function that returns the jQuery object or a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.

$(function() {
    $("#contextMenuContainer").dxContextMenu({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});

<dx-context-menu ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-context-menu>

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxContextMenuModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxContextMenuModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxContextMenu ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxContextMenu>
</template>

<script>

import DxContextMenu, {
    DxItem
} from 'devextreme-vue/context-menu';

export default {
    components: {
        DxContextMenu,
        DxItem
    },
    // ...
}
</script>

import React from 'react';

import ContextMenu, {
    Item
} from 'devextreme-react/context-menu';

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

class App extends React.Component {
    render() {
        return (
            <ContextMenu ... >
                <Item ...
                    render={renderCustomItem}
                >
                </Item>
            </ContextMenu>
        );
    }
}
export default App;

View on GitHub

See Also

• Custom Templates