A newer version of this page is available. Switch to the current version.

jQuery DropDownButton - items

Provides drop-down menu items.

Default Value: null

The items array can contain:

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

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

badge

Specifies the text of a badge displayed for the list item.

Type:

String

If the property value is undefined or an empty string, the badge is not displayed.

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies the HTML markup to be inserted into the item element.

Type:

String

The DropDownButton component evaluates the html property's value. This evaluation, however, makes the DropDownButton potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.

You can use the text property as a safe alternative.

icon

Specifies the list item's icon.

Type:

String

This property accepts one of the following:

onClick

A handler for the click event raised for a certain item in the drop-down field.

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

DropDownButton

The UI component's instance.

element

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

model any

Model data. Available only if you use Knockout.

itemData

Object

The item's data.

itemElement

HTMLElement | jQuery

The item's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

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() {
    $("#dropDownButtonContainer").dxDropDownButton({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-drop-down-button ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-drop-down-button>
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 { DxDropDownButtonModule } from 'devextreme-angular';

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

<script>

import DxDropDownButton, {
    DxItem
} from 'devextreme-vue/drop-down-button';

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

import DropDownButton, {
    Item
} from 'devextreme-react/drop-down-button';

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

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

text

Specifies text displayed for the UI component item.

Type:

String

visible

Specifies whether or not a UI component item must be displayed.

Type:

Boolean

Default Value: true