JavaScript/jQuery TabPanel - items
An array of items displayed by the UI component.
Array<String | dxTabPanelItem | any>
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:
tabPanelInstance.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.
disabled
Specifies whether the UI component item responds to user interaction.
html
Specifies the HTML markup to be inserted into the item element.
The TabPanel component evaluates the html property's value. This evaluation, however, makes the TabPanel potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.
You can use the text property as a safe alternative.
icon
Specifies the icon to be displayed in the tab's title.
This property accepts one of the following:
- The icon's URL
- The icon's name if the icon is from the DevExtreme icon library
- The icon's CSS class if the icon is from an external icon library (see External Icon Libraries)
- The icon in the Base64 format
- The icon in the SVG format. Ensure that the source is reliable.
tabTemplate
Specifies a template that should be used to render the tab for this item only.
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.
jQuery
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.
The following example adds a custom item to the component.
$(function() { $("#tabPanelContainer").dxTabPanel({ // ... items: [ { // ... template: '<div>Custom Item</div>' } ] }); });
Angular
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. Note that Angular uses custom templates instead of the template property.
<dx-tab-panel ... > <dxi-item ... > <div *dxTemplate> <div>Custom Item</div> </div> </dxi-item> </dx-tab-panel>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxTabPanelModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxTabPanelModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. Note that Vue uses custom templates instead of the template property.
<template> <DxTabPanel ... > <dxItem ... > <div>Custom Item</div> </dxItem> </DxTabPanel> </template> <script> import DxTabPanel, { DxItem } from 'devextreme-vue/tab-panel'; export default { components: { DxTabPanel, DxItem }, // ... } </script>
React
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a DOM Node of the template's container.
The following example adds a custom item to the component. In React, specify the render or component properties.
import React from 'react'; import TabPanel, { Item } from 'devextreme-react/tab-panel'; const renderCustomItem = () => { return <div>Custom Item</div>; } const App() = () => { return ( <TabPanel ... > <Item ... render={renderCustomItem} > </Item> </TabPanel> ); } export default App;
See Also
text
Specifies text displayed for the UI component item.
If you use both this property and a template, the template overrides the text.
title
Specifies the item title text displayed on a corresponding tab.
If tab titles are too long to be dispayed in full, you can handle them in one of multiple ways with CSS. To learn how to display long tab titles, refer to the following example:
Angular
In Angular, the title's value can also be passed to the browser tooltip. This happens because this property 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:
<dxi-item [title]="'Customers'">