Tabs

A tab strip used to switch between pages.

Type: Object

The dxTabs widget displays items that perform an action when clicked. To create the dxTabs widget, add a div element with dxTabs Knockout binding within the body of the required view.

HTML
<div data-bind="dxTabs:{dataSource: tabs, itemClickAction: tabClicked}"></div>

The tabs are loaded from an array specified from the dataSource configuration option. You can specify an array of objects as the widget data source.

JavaScript
var tabs = [
    { text: "user", icon: "user" },
    { text: "comment", icon: "comment" },
    { text: "find", icon: "find"}
];

You can use the icons from the built-in icon library. For this purpose, specify the icon field in the widget data source (see the example above). Alternatively, you can set external icons using the iconSrc field of the widget data source, as shown in the following example.

JavaScript
var navItems = [
        { text: "user", iconSrc: "images/icons/user.png" },
        { text: "find", iconSrc: "images/icons/find.png" },
    ];

To display widget items, a default template is applied based on the following fields of the data source item objects.

  • disabled
    Specifies whether or not the widget item is disabled.
  • visible
    Specifies whether or not the widget item is visible.
  • html
    Specifies the html code inserted into the item element.
  • text
    Specifies the text inserted into the item element.
  • icon
    Specifies the name of the icon displayed by the widget item.
  • iconsrc
    Specifies a URL pointing to the image to be displayed by the widget item.

You can introduce a custom template for the widget's items. For this purpose, add a div element with the data-options attribute set to dxTemplate. Assign item to the template name. In this instance, the template will be applied automatically. See the Customize Widget Item Appearance topic to learn more about templates.

Declare a function that processes a tab click and assign it to the itemClickAction configuration option.

JavaScript
var tabClicked = function(e){
    alert(e.itemData.text + " tab clicked");
};

Note that you can access the clicked item fields via the itemData field of the object passed as an argument to the itemClickAction function.

Refer to the Add a Widget documentation section to learn how to create widgets in detail.

Show Example:
jQuery

Configuration

An object defining configuration options for the dxTabs widget.

Methods

This section describes methods that can be used to manipulate a widget.

Events

This section describes events fired by this component.