Angular Menu - items

Holds an array of menu items.

Selector: dxi-item
Type:

Array<dxMenuItem>

Raised Events: onOptionChanged

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:

JavaScript
menuInstance.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.

NOTE
Do not use the items property if you use dataSource, and vice versa.

beginGroup

Specifies whether a group separator is displayed over the item.

Type:

Boolean

You can add group separators only between items in submenus.

closeMenuOnClick

Specifies if a menu is closed when a user clicks the item.

Type:

Boolean

Default Value: true

disabled

Specifies whether the menu item responds to user interaction.

Type:

Boolean

Default Value: false

icon

Specifies the menu item's icon.

Type:

String

This property accepts one of the following:

items

Specifies nested menu items.

Selector: dxi-item
Type:

Array<dxMenuItem>

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

linkAttr

Specifies link attributes for the url option.

Selector: dxo-link-attr
Type:

Object

Default Value: {}

You can assign all attributes described in the Attributes article except for the following:

  • href
    Use the url property to specify a link instead.

  • Global attributes
    You can specify only id, class, and aria-* global attributes.

NOTE

  • If you assign a target: '_blank' attribute, add a rel: 'noopener' or rel: 'noreferrer' attribute to avoid security issues.

  • When an item receives focus, screen readers should announce a description of the link. Add an aria-label attribute with the description to inform users.

The following code opens a link in a new window or tab:

jQuery
index.js
$(function() {
    const menu = $("#menu").dxMenu({
        items: [
            {
                text: 'Home',
                url: 'https://js.devexpress.com',
                linkAttr: {
                    target: '_blank',
                    rel: 'noopener'
                }
            }
        ]
    }).dxMenu('instance');
});
Angular
app.component.html
app.component.ts
<dx-menu>
    <dxi-item 
        text="Home"
        url="https://js.devexpress.com"
        [linkAttr]="linkAttr"
    >
    </dxi-item>
</dx-menu>
import { Component } from '@angular/core';

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

export class AppComponent {
    linkAttr = {
        target: '_blank',
        rel: 'noopener'
    }
}
Vue
App.vue
<template>
    <dxMenu>
        <dxItem 
            text="Home"
            url="https://js.devexpress.com"
            :link-attr="linkAttr"
        />
    </dxMenu>
</template>

<script>
    import DxMenu, { DxItem } from 'devextreme-vue/menu';

    export default {
        components: {
            DxMenu,
            DxItem
        },
        data() {
            return {
                linkAttr: {
                    target: '_blank',
                    rel: 'noopener'
                }
            };
        }
    }
</script>
React
App.js
import React from 'react';
import Menu, { Item } from 'devextreme-react/menu';

const linkAttr = {
    target: '_blank',
    rel: 'noopener'
};

function App() {
    return (
        <Menu>
            <Item
                text="Home"
                url="https://js.devexpress.com"
                linkAttr={linkAttr}
            />
        </Menu>
    );
}

export default App;

selectable

Specifies whether or not a user can select a menu item.

Type:

Boolean

Default Value: false

selected

Specifies whether or not the item is selected.

Type:

Boolean

Default Value: false

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data:

CollectionWidgetItem

The item object to be rendered.

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.

jQuery
index.js
$(function() {
    $("#menuContainer").dxMenu({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-menu ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-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 { DxMenuModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxMenuModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxMenu ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxMenu>
</template>

<script>

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

export default {
    components: {
        DxMenu,
        DxItem
    },
    // ...
}
</script>
React
App.js
import React from 'react';

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

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

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

View on GitHub

See Also

text

Specifies the text inserted into the item element.

Type:

String

url

Specifies a web address to be opened when a user clicks on an item.

Type:

String

The following code opens a link in the same frame the item was clicked:

jQuery
index.js
$(function() {
    const menu = $("#menu").dxMenu({
        items: [
            {
                icon: 'home',
                url: 'https://js.devexpress.com',
            }
        ]
    }).dxMenu('instance');
});
Angular
app.component.html
<dx-menu>
    <dxi-item 
        icon="home"
        url="https://js.devexpress.com"
    >
    </dxi-item>
</dx-menu>
Vue
App.vue
<template>
    <dxMenu>
        <dxItem 
            icon="home"
            url="https://js.devexpress.com"
        />
    </dxMenu>
</template>

<script>
    import DxMenu, { DxItem } from 'devextreme-vue/menu';

    export default {
        components: {
            DxMenu,
            DxItem
        },
        data() {
            return {
                // ...
            };
        }
    }
</script>
React
App.js
import React from 'react';
import Menu, { Item } from 'devextreme-react/menu';

function App() {
    return (
        <Menu>
            <Item
                icon="home"
                url="https://js.devexpress.com"
            />
        </Menu>
    );
}

export default App;

To assign link attributes, specify the linkAttr property.

jQuery

If you specify a template for an item, do not specify this property. Define a link in the markup instead.

index.js
$(function() {
    $("#menu").dxMenu({
        items: [
            {
                template: '<a href="http://js.devexpress.com" target="_blank">Home</a>'
            }
        ]
    });
});
Angular

If you specify a template for an item, do not specify this property. Define a link in the markup instead.

app.component.html
<dx-menu>
    <dxi-item>
        <div *dxTemplate>
            <a href="http://js.devexpress.com" target="_blank">Home</a>
        </div>
    </dxi-item>  
</dx-menu>

If you use routing for your project, specify <a> links inside items. Alternatively, you can implement the onItemClick event handler to process clicks on links.

app.component.html
<dx-menu>
    <dxi-item><a routerLink="/">Home</a></dxi-item>
    <dxi-item><a routerLink="/about">About</a></dxi-item>
</dx-menu>
<router-outlet></router-outlet>
Vue

If you specify a template for an item, do not specify this property. Define a link in the markup instead.

App.vue
<template>
    <DxMenu>
        <DxItem><a href="http://js.devexpress.com" target="_blank">Home</a></DxItem>
    </DxMenu>
</template>

<script>
    import DxMenu, { DxItem } from 'devextreme-vue/menu';

    export default {
        components: {
            DxMenu,
            DxItem
        },
        data() {
            return {
                // ...
            };
        }
    }
</script>

If you use routing for your project, specify <router-link> links inside items. Alternatively, you can implement the onItemClick event handler to process clicks on links.

App.vue
<template>
    <DxMenu>
        <DxItem><template #default><router-link to="/">Home</router-link></template></DxItem>
        <DxItem><template #default><router-link to="/about">About</router-link></template></DxItem>
    </DxMenu>
    <router-view/>
</template>

<script>
    import DxMenu, { DxItem } from 'devextreme-vue/menu';

    export default {
        components: {
            DxMenu,
            DxItem
        },
        data() {
            return {
                // ...
            };
        }
    }
</script>
React

If you specify a rendering function or a component for an item, do not specify this property. Define a link in the markup instead.

App.js
import React from 'react';
import Menu, { Item } from 'devextreme-react/menu';

const renderLink = () => {
    return <a href="http://js.devexpress.com" target="_blank">Home</a>;
}

function App() {
    return (
        <Menu>
            <Item render={renderLink} />
        </Menu>
    );
}

export default App;

If you use routing for your project, specify <Link> links inside items. Alternatively, you can implement the onItemClick event handler to process clicks on links.

App.js
import React from 'react';
import Menu, { Item } from 'devextreme-react/menu';
import { Routes, Outlet, Route, Link } from "react-router-dom";

function App() {
    return (
        <Menu>
            <Item>
              <Link to="/">Home</Link>
            </Item>
            <Item>
              <Link to="/about">About</Link>
            </Item>
        </Menu>
        <Routes>
            <Route exact path="/" element={<Home />}></Route>
            <Route path="/about" element={<About />}></Route>
        </Routes>
        <Outlet />
    );
}

export default App;

visible

Specifies whether or not the menu item is visible.

Type:

Boolean

Default Value: true