JavaScript/jQuery Tabs Options

See Also

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

The Tabs works with collections of string values or objects.

Depending on your data source, bind Tabs to data as follows. If the data source provides objects, also specify the itemTemplate. You can skip this part if the objects contain fields described in the items section.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#tabsContainer").dxTabs({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-tabs ...
      [dataSource]="store">
  </dx-tabs>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxTabsModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTabsModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxTabs ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxTabs } from 'devextreme-vue/tabs';
  
  export default {
      components: {
          DxTabs
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import Tabs from 'devextreme-react/tabs';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <Tabs ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Tabs always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

The following values are available:

• 'start'
  The icon appears before the text.

• 'end'
  The icon appears after the text.

• 'top'
  The icon appears above the text.

• 'bottom'
  The icon appears below the text.

The alignment of content in a tab item directly depends on the iconPosition value. If a tab item has an icon and iconPosition: 'top' or iconPosition: 'bottom', the content alignment is centered. If you set iconPosition: 'start' or iconPosition: 'end', the content is aligned to the edge of the tab.

The same applies if items do not include icons: content is aligned equally in all tab items.

View Demo

The items array can contain:

• Strings
• Objects with fields described in this section. If you want use other fields, specify the itemTemplate.

If you need to update the UI component items, reassign the items array as shown in the following example:

tabsInstance.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.

See Also

• Custom Templates

See Also

• Specify data using dataSource property
• Specify data using items property

The Tabs component evaluates the noDataText property's value. This evaluation, however, makes the Tabs potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.

<dx-tabs ...
    (onInitialized)="saveInstance($event)">
</dx-tabs>

import { Component } from "@angular/core";
import Tabs from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    tabsInstance: Tabs;
    saveInstance (e) {
        this.tabsInstance = e.component;
    }
}

<template>
    <div>
        <DxTabs ...
            @initialized="saveInstance">
        </DxTabs>
    </div>
</template>

<script>
import DxTabs from 'devextreme-vue/tabs';

export default {
    components: {
        DxTabs
    },
    data: function() {
        return {
            tabsInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.tabsInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxTabs ...
            @initialized="saveInstance">
        </DxTabs>
    </div>
</template>

<script setup>
import DxTabs from 'devextreme-vue/tabs';

let tabsInstance = null;

const saveInstance = (e) => {
    tabsInstance = e.component;
}
</script>

import Tabs from 'devextreme-react/tabs';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.tabsInstance = e.component;
    }

    render() {
        return (
            <div>
                <Tabs onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

The following example shows how to subscribe to component property changes:

$(function() {
    $("#tabsContainer").dxTabs({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-tabs ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-tabs>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxTabsModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxTabsModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxTabs ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxTabs from 'devextreme-vue/tabs'; 

export default { 
    components: { 
        DxTabs
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import Tabs from 'devextreme-react/tabs'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <Tabs ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

The following orientations are available:

• 'horizontal' (default)

• 'vertical'

View Demo

See Also

• push(changes) in: ArrayStore | CustomStore | LocalStore | ODataStore
• DataSource.reshapeOnPush

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

The item keys can be specified using the keyExpr property or the key property within the underlying Store.

See Also

• key in ArrayStore | CustomStore | LocalStore | ODataStore

The following styling modes are available:

• 'primary'
  The width of the underline is fixed.
  

• 'secondary'
  The width of the underline depends on tab content.
  

View Demo

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".