JavaScript/jQuery DropDownButton - items
Provides drop-down menu items.
Array<dxDropDownButtonItem | any>
| nullThe items array can contain:
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the keyExpr and displayExpr or itemTemplate.
If you need to update the UI component items, reassign the entire items array as shown in the following example:
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.
badge
Specifies the text of a badge displayed for the list item.
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.
html
Specifies the HTML markup to be inserted into the item element.
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.
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.
onClick
A handler for the click event raised for a certain item in the drop-down field.
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The UI component's instance. |
|
| element |
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. |
| itemData |
The item's data. |
|
| itemElement |
The item's container. It is an HTML Element or a jQuery Element when you use jQuery. |
template
Specifies a template that should be used to render this item only.
jQuery
This property supports the following values:
- A template container as a jQuery object or DOM Node
- A function that returns a template container (as a jQuery object or DOM node)
For more information about templates, refer to the following help topic: DevExtreme jQuery - Custom Templates.
$(function() {
$("#dropDownButtonContainer").dxDropDownButton({
// ...
items: [
{
// ...
template: '<div>Custom Item</div>'
}
]
});
});Angular
For more information about templates, refer to the following help topic: DevExtreme jQuery - Custom Templates.
<dx-drop-down-button ... >
<dxi-drop-down-button-item ... >
<div *dxTemplate>
<div>Custom Item</div>
</div>
</dxi-drop-down-button-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
For more information about templates, refer to the following help topic: DevExtreme jQuery - Custom Templates.
<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
For more information about templates, refer to the following help topic: DevExtreme jQuery - Custom Templates.
import React from 'react';
import DropDownButton, {
Item
} from 'devextreme-react/drop-down-button';
const renderCustomItem = () => {
return <div>Custom Item</div>;
}
const App() = () => {
return (
<DropDownButton ... >
<Item ...
render={renderCustomItem}
>
</Item>
</DropDownButton>
);
}
export default App;See Also
text
Specifies text displayed for the UI component item.
If you use both this property and a template, the template overrides the text.