Angular List - items

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:

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.

View Demo

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

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.

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.

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.

$(function() {
    $("#listContainer").dxList({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});

<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 { }

<template>
    <DxList ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxList>
</template>

<script>

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

export default {
    components: {
        DxList,
        DxItem
    },
    // ...
}
</script>

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

• Custom Templates