Vue List Default Item Template

This section describes object fields that can be used in the default item template.

Type:

Object

See Also

badge

Specifies the text of a badge displayed for the list item.

Type:

String

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

component

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

disabled

Specifies whether a widget item should be disabled.

Type:

Boolean

Default Value: false

html

Specifies html code inserted into the widget item element.

Type:

String

icon

Specifies the list item's icon.

Type:

String

This option 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 option 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 an item template that should be used to render this item only.

Type:

template

Template Data: undefined

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

Type:

String

visible

Specifies whether or not a widget item must be displayed.

Type:

Boolean

Default Value: true