Default Item Template

This section lists the data source fields that are used in a default template for list items.

By default, a predefined item template is applied to display items of DevExtreme collection widgets. This template is based on certain fields of the data source provided for a widget. Below is the list of the fields that take part in a default item template for the dxList widget. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source. For details refer to the Customize Widget Item Appearance topic.

disabled

Specifies whether a widget item must be displayed disabled.

Type: Boolean
Default Value: false

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are displayed disabled or enabled according to the specified value.

editTemplate

Specifies an item template that should be used to render this item only if the editEnabled option is set to true.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery

A template name or a template container.

This option is similar to the template option.

html

Specifies html code inserted into the widget item element.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required markup is used to display widget items.

key

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

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the list item corresponds to the required group.

template

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

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery

A template name or a template container.

Whether you use a default or a custom template for widget items, you can specify a specific template for a particular item. To do so, set the template field for the data source object of this item. The following types of the specified value are available.

  • Assign a string representing the name of the required template.
  • Assign a jQuery object representing the template's container.
  • Assign a DOM Node representing the template's container.
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container.

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

text

Specifies text displayed for the widget item.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required text is displayed for the widget items.

visible

Specifies whether a widget item must be displayed.

Type: Boolean
Default Value: true

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are either visible or not visible according to the specified value.