React Pivot API Deprecated

NOTE
The Pivot widget is deprecated since v18.1. We recommend using the TabPanel widget instead.

The Pivot provides a quick way to manage multiple views. It includes a collection of views and a navigation header. An end user switches the views by swiping them or by clicking their titles on the navigation header.

import Pivot from "devextreme-react/pivot"
Type:

Object

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Pivot widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery
JavaScript
HTML
$(function () {
    $("#pivot").dxPivot({
        items: [{
            title: "Item 1 Title",
            text: "Item 1 Text Content"
        }, {
            title: "Item 2 Title",
            text: "Item 2 Text Content"
        }, {
            title: "Item 3 Title",
            text: "Item 3 Text Content"
        }],
        height: 300
    });
});
<div id="pivot"></div>
Angular
HTML
TypeScript
<dx-pivot
    [items]="pivotItems"
    [height]="300">
</dx-pivot>
import { DxPivotModule } from "devextreme-angular";
// ...
export class AppComponent {
    pivotItems = [{
        title: "Item 1 Title",
        text: "Item 1 Text Content"
    }, {
        title: "Item 2 Title",
        text: "Item 2 Text Content"
    }, {
        title: "Item 3 Title",
        text: "Item 3 Text Content"
    }];
}
@NgModule({
    imports: [
        // ...
        DxPivotModule
    ],
    // ...
})
AngularJS
HTML
JavaScript
<div ng-controller="DemoController">
    <div dx-pivot="{
        items: pivotItems,
        height: 300
    }"></div>
</div>
angular.module("DemoApp", ["dx"])
    .controller("DemoController", function ($scope) {
        $scope.pivotItems = [{
            title: "Item 1 Title",
            text: "Item 1 Text Content"
        }, {
            title: "Item 2 Title",
            text: "Item 2 Text Content"
        }, {
            title: "Item 3 Title",
            text: "Item 3 Text Content"
        }];
    });
Knockout
HTML
JavaScript
<div data-bind="dxPivot: {
    items: pivotItems,
    height: 300
}"></div>
var viewModel = {
    pivotItems: [{
        title: "Item 1 Title",
        text: "Item 1 Text Content"
    }, {
        title: "Item 2 Title",
        text: "Item 2 Text Content"
    }, {
        title: "Item 3 Title",
        text: "Item 3 Text Content"
    }]
};
ko.applyBindings(viewModel);
See Also

Configuration

An object defining configuration options for the Pivot widget.

Name Description
activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.
contentTemplate

Specifies a custom template for the widget content. Rendered only once - when the widget is created.
dataSource

Binds the widget to data.
disabled

Specifies whether the widget responds to user interaction.
elementAttr

Specifies the attributes to be attached to the widget's root element.
height

Specifies the widget's height.
hint

Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.
itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.
items

An array of items displayed by the widget.
itemTemplate

Specifies a custom template for items.
itemTitleTemplate

Specifies a custom template for item titles.
onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing

A function that is executed before the widget is disposed of.
onInitialized

A function used in JavaScript frameworks to save the widget instance.
onItemClick

A function that is executed when a collection item is clicked or tapped.
onItemContextMenu

A function that is executed when a collection item is right-clicked or pressed.
onItemHold

A function that is executed when a collection item has been held for a specified period.
onItemRendered

A function that is executed after a collection item is rendered.
onOptionChanged

A function that is executed after a widget option is changed.
onSelectionChanged

A function that is executed when a collection item is selected or selection is canceled.
rtlEnabled

Switches the widget to a right-to-left representation.
selectedIndex

The index of the currently active pivot item.
selectedItem

The selected item object.
swipeEnabled

A Boolean value specifying whether or not to allow users to switch between items by swiping.
visible

Specifies whether the widget is visible.
width

Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.
dispose()

Disposes of all the resources allocated to the Pivot instance.
element()

Gets the root widget element.
endUpdate()

Refreshes the widget after a call of the beginUpdate() method.
getDataSource()

Gets the DataSource instance.
getInstance(element)

Gets the instance of a widget found using its DOM node.
instance()

Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
option()

Gets all widget options.
option(optionName)

Gets the value of a single option.
option(optionName, optionValue)

Updates the value of a single option.
option(options)

Updates the values of several options.
repaint()

Repaints the widget without reloading data. Call it to update the widget's markup.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.
disposing

Raised before the widget is disposed of.
initialized

Raised only once, after the widget is initialized.
itemClick

Raised when a collection item is clicked or tapped.
itemContextMenu

Raised when a collection item is right-clicked or pressed.
itemHold

Raised when a collection item has been held for a specified period.
itemRendered

Raised after a collection item is rendered.
optionChanged

Raised after a widget option is changed.
selectionChanged

Raised when a collection item is selected or selection is canceled.

See Also

Default Item Template

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

Type:

Object

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 the 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