Box
Map
Vue
A newer version of this page is available. Switch to the current version.

JavaScript/jQuery List - items

An array of items displayed by the UI component.

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.

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.

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 html code inserted into the UI component item element.

Type:

String

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

render

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

showChevron

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

Type:

Boolean

template

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

Type:

template

Template Data: undefined

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