TabPanel

The TabPanel is a widget consisting of the Tabs and MultiView widgets. It automatically synchronizes the selected tab with the currently displayed view and vice versa.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js

Module: ui/tab_panel

Export: default

import TabPanel from "devextreme/ui/tab_panel";

new TabPanel(container, {

});

You can create the widget using one of the following approaches.

jQuery

HTML

JavaScript

<div id="tabPanel"></div>

var tabs = [{
    title: 'Info',
    text: 'This is Info Tab'
}, {
    title: 'Contacts',
    text: 'This is Contacts Tab'
}, {
    title: 'Address',
    text: 'This is Address Tab'
}];
$(function () {
    $("#tabPanel").dxTabPanel({
        items: tabs
    });
});

Angular

HTML

JavaScript

<dx-tab-panel [items]="tabs"></dx-tab-panel>

export class AppComponent {
    tabs = [
        // ...
    ];
}

AngularJS

HTML

JavaScript

<div ng-controller="DemoController">
    <div dx-tab-panel="{
        items: tabs
    }"></div>
</div>

angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.tabs = [
            // ...   
        ];
    });

Knockout

HTML

JavaScript

<div data-bind="dxTabPanel: {
    items: tabs
}"></div>

var viewModel = {
    tabs: [
        // ...
    ]
};
ko.applyBindings(viewModel);

ASP.NET MVC Wrappers

Razor C#

Razor VB

@(Html.DevExtreme().TabPanel()
    .ID("tabPanel")
    .Items(items => {
        items.Add().Title("Info").Text("This is Info Tab");
        items.Add().Title("Contacts").Text("This is Contacts Tab");
        items.Add().Title("Address").Text("This is Address Tab");
    })
)

@(Html.DevExtreme().TabPanel() _
    .ID("tabPanel") _
    .Items(Sub(items)
        items.Add().Title("Info").Text("This is Info Tab")
        items.Add().Title("Contacts").Text("This is Contacts Tab")
        items.Add().Title("Address").Text("This is Address Tab")
    End Sub)
)

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

View Demo Watch Video

Configuration

An object defining configuration options for the TabPanel widget.

Name	Description
accessKey	Specifies a shortcut key that sets focus on the widget element.
activeStateEnabled	A Boolean value specifying whether or not the widget changes its state when interacting with a user.
animationEnabled	Specifies whether or not to animate the displayed item change.
dataSource	A data source used to fetch data to be displayed by the widget.
deferRendering	Specifies whether widget content is rendered when the widget is shown or when rendering the widget.
disabled	A Boolean value specifying whether or not the widget can respond to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether or not the widget can be focused.
height	Specifies the height of the widget.
hint	Specifies the text of the hint displayed for the widget.
hoverStateEnabled	A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.
itemHoldTimeout	The time period in milliseconds before the onItemHold event is raised.
items	An array of items displayed by the widget.
itemTemplate	The template to be used for rendering items.
itemTitleTemplate	The template to be used for rendering an item title.
loop	A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped.
onContentReady	A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.
onDisposing	A handler for the disposing event.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onItemClick	A handler for the itemClick event.
onItemContextMenu	A handler for the itemContextMenu event.
onItemHold	A handler for the itemHold event.
onItemRendered	A handler for the itemRendered event.
onOptionChanged	A handler for the optionChanged event.
onSelectionChanged	A handler for the selectionChanged event.
onTitleClick	A handler for the titleClick event.
onTitleHold	A handler for the titleHold event.
onTitleRendered	A handler for the titleRendered event.
rtlEnabled	Specifies whether or not the current component supports a right-to-left representation.
scrollByContent	A Boolean value specifying if tabs in the title are scrolled by content.
scrollingEnabled	A Boolean indicating whether or not to add scrolling support for tabs in the title.
selectedIndex	The index of the currently displayed item.
selectedItem	The selected item object.
showNavButtons	A Boolean value that specifies the availability of navigation buttons.
swipeEnabled	A Boolean value specifying whether or not to allow users to change the selected index by swiping.
tabIndex	Specifies the widget tab index.
visible	A Boolean value specifying whether or not the widget is visible.
width	Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the component from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
element()	Returns the root HTML element of the widget.
endUpdate()	Enables the component to refresh after the beginUpdate() method call.
focus()	Sets focus on the widget.
getDataSource()	Allows you to get the DataSource instance.
instance()	Returns an instance of this component class.
off(eventName)	Detaches all event handlers from the specified event.
off(eventName, eventHandler)	Detaches a particular event handler from the specified event.
on(eventName, eventHandler)	Subscribes to a specified event.
on(events)	Subscribes to the specified events.
option()	Returns the configuration options of this component.
option(optionName)	Gets the value of the specified configuration option of this component.
option(optionName, optionValue)	Sets a value to the specified configuration option of this component.
option(options)	Sets one or more options of this component.
registerKeyHandler(key, handler)	Registers a handler when a specified key is pressed.
repaint()	Redraws the widget.

Events

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Fires when the widget is being removed.
initialized	Raised only once, after the widget is initialized.
itemClick	Fires when a widget item is clicked.
itemContextMenu	Fires when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.
itemHold	Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.
itemRendered	Fires after a collection item is rendered.
optionChanged	Fires after an option of the component is changed.
selectionChanged	Fires after a collection item is selected or unselected.
titleClick	Fires when a widget item title is clicked.
titleHold	Fires when the widget item title is being held for the time period specified by the itemHoldTimeout option.
titleRendered	Fires after a widget item title is rendered.

Default Item Template

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

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.

TabPanel

See Also

Configuration

Methods

Events

See Also

Default Item Template

See Also