React DropDownBox - items

An array of items used to synchronize the DropDownBox with an embedded UI component.

Type:

Array<any>

The DropDownBox uses other UI components to render items. Use the contentTemplate to embed a UI component such as the List or the TreeView. In this case, items are displayed in accordance with the configuration and functionality of the embedded UI component.

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

JavaScript
dropDownBoxInstance.option('items', newItems);

You can use the dataSource property instead of items. It accepts the DataSource object whose underlying stores include 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).

component

An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

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 DropDownBox component evaluates the html property's value. This evaluation, however, makes the DropDownBox 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.

render

An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

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

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

<script>

import DxDropDownBox, {
    DxItem
} from 'devextreme-vue/drop-down-box';

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

import DropDownBox, {
    Item
} from 'devextreme-react/drop-down-box';

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

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

View on GitHub

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