Vue List - items

An array of items displayed by the UI component.

Selector: DxItem
Type:

Array<String | dxListItem | any>

Raised Events: onOptionChanged

The items array can contain:

  • Strings
  • 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
listInstance.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.

View Demo

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

key

Specifies the name of the list items group in a grouped list.

Type:

String

showChevron

Specifies whether or not to display a chevron for the list item.

Selector: show-chevron
Type:

Boolean

template

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

Type:

template

Template Data: any

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 property.

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

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

<script>

import DxList, {
    DxItem
} from 'devextreme-vue/list';

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

import List, {
    Item
} from 'devextreme-react/list';

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

class App extends React.Component {
    render() {
        return (
            <List ... >
                <Item ...
                    render={renderCustomItem}
                >
                </Item>
            </List>
        );
    }
}
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