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

JavaScript/jQuery Box - 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
boxInstance.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.

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 property when the UI component 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.

Default Value: undefined

Use this field to make the item a nested Box UI component.

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

ratio

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

Type:

Number

Default Value: 0

render

An alias for the template property 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 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