TabPanel

A widget used to display a view and to switch between several views by clicking the appropriate tabs.

Included in: dx.phonejs.js, dx.webappjs.js, dx.all.js

The dxTabPanel widget consists of the dxTabs and dxMultiView widgets. It automatically synchronizes the selected tab and the currently displayed view. If a user switches a tab, the widget displays the appropriate view and when a user switches a view by swiping, the widget selects the appropriate tab. Each view and each tab displayed by the widget corresponds to a data source item. The widget uses a template specified by the itemTemplate option to render a view. The titleTemplate option specifies the template used to render a tab.

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

  • jQuery
    Use the dxTabPanel jQuery plug-in.

    HTML
    <div id="tabPanel"></div>
    JavaScript
    $("#tabPanel").dxTabPanel({
        dataSource: tabPanelData,
        swipeEnabled: true,
        loop: true,
        animationEnabled: false
    });
  • Knockout
    Add a div element and apply the dxTabPanel binding to this element.

    HTML
    <div data-bind="dxTabPanel: {
        dataSource: tabPanelData,
        swipeEnabled: true,
        loop: true,
        animationEnabled: false
    }"></div>
  • Angular
    Add a div element and apply the dx-tab-panel directive to this element.

    HTML
    <div dx-tab-panel="{
        dataSource: tabPanelData,
        swipeEnabled: true,
        loop: true,
        animationEnabled: false
    }"></div>

Note that DevExtreme widgets require you to link the jQuery and Globalize libraries to your application. If you use the Knockout or Angular approach, the Knockout or Angular library is also required.

See Also

Since the dxTabPanel widget is used to display multiple items, it supports common the Collection Container widget functionality. You can find detailed information on the principles of working with the widget in the dxTabPanel section of the Collection Container Widgets article.

View Demo

Watch Video

Configuration

An object defining configuration options for the dxTabPanel 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.

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.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

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.

selectedIndex

The index of the currently displayed item.

selectedItem

The selected item object.

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.

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 exposed by this widget.

Name Description
contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

itemClick

Fires when a widget item is clicked.

itemContextMenu

Fires when the 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.

See Also