JavaScript/jQuery Box Default Item Template

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

Type:

Object

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. 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.

See Also

baseSize

Specifies the base size of an item element along the main direction.

Type:

Number

|

String

Default Value: 0
Accepted Values: 'auto'

Use the Mode enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Auto.

See Also

box

Holds a Box configuration object for the item.

Type:

Box Configuration

Default Value: undefined

Use this field to make the item a nested Box widget.

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

ratio

Specifies the ratio value used to count the item element size along the main direction.

Type:

Number

Default Value: 0

See Also

render

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

shrink

A factor that defines how much an item shrinks relative to the rest of the items in the container.

Type:

Number

Default Value: 1

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