JavaScript/jQuery TabPanel - items
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.
html
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
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
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
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. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.
jQuery
$(function() { $("#tabPanelContainer").dxTabPanel({ // ... items: [ { // ... template: '<div>Custom Item</div>' } ] }); });
Angular
<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
<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
import React from 'react'; import TabPanel, { Item } from 'devextreme-react/tab-panel'; const renderCustomItem = () => { return <div>Custom Item</div>; } class App extends React.Component { render() { return ( <TabPanel ... > <Item ... render={renderCustomItem} > </Item> </TabPanel> ); } } export default App;
See Also
title
In Angular, the title's value can also be passed to 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'">
If you have technical questions, please create a support ticket in the DevExpress Support Center.