items[]

An array of items displayed by the widget.

Raised Events: optionChanged

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 widget items, reassign the entire items array as shown in the following example:

JavaScript
tabPanelInstance.option('items', newItems);

As an alternative to items, you can use the dataSource option. 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 option if you use dataSource, and vice versa.

badge

Specifies a badge text for the tab.

Type:

String

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 icon to be displayed in the tab's title.

Type:

String

This option accepts one of the following:

render

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

tabComponent

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

tabRender

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

tabTemplate

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

Type:

template

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

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

template

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

Type:

template

Return Value:

String

|

DOM Node

|

jQuery

A template name or container.

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

title

Specifies the item title text displayed on a corresponding tab.

Type:

String

NOTE

In Angular, the title's value can also be passed to browser tooltip. This happens because this option has the same name as the HTML attribute that specifies the tooltip's text.
To avoid this behavior, wrap the property in square brackets and wrap the property value in single quotes:

HTML
<dxi-item [title]="'Customers'">