JavaScript/jQuery Toolbar Options

See Also

The Toolbar works with collections of string values or objects.

Depending on your data source, bind the Toolbar 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";
      $("#toolbarContainer").dxToolbar({
          // ...
          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-toolbar ...
      [dataSource]="store">
  </dx-toolbar>

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

  Vue

  App.vue

  <template> 
      <DxToolbar ...
          :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 { DxToolbar } from 'devextreme-vue/toolbar';
  
  export default {
      components: {
          DxToolbar
      },
      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 Toolbar from 'devextreme-react/toolbar';
  
  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 (
              <Toolbar ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the Toolbar 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.

The items array can contain:

• Strings
• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

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

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

• Customize Item Appearance
• Custom Templates

$(function() {
    $("#toolbar").dxToolbar({
        items: [
            // ...
        ],
        menuItemTemplate (data, index) {
            return $(`<div>${(index + 1)}. ${data.options.text}</div>`);
        }
    });
});

<dx-toolbar
    menuItemTemplate="menu-item"
>
    <dxi-item ... >
    </dxi-item>
    <div *dxTemplate="let data of 'menu-item'; let index = index">
        {{index + 1}}. {{data.options.text}}
    </div>
</dx-toolbar>

<template>
    <DxToolbar
        menu-item-template="menu-item"
    >
        <dxItem ... >
        </dxItem>
        <template #menu-item="{ data, index }">
            {{index + 1}}. {{data.options.text}}
        </template>
    </DxToolbar>
</template>

<script>
// ...
</script>

import React from 'react';
import Toolbar, { Item } from 'devextreme-react/toolbar';

const renderMenuItem = (data, index) => {
    return <div>{index + 1}. {data.options.text}</div>;
}

function App() {
    return (
        <Toolbar
            menuItemRender={renderMenuItem}
        >
            <Item ... >
            </Item>
        </Toolbar>
    );
}

export default App;

See Also

• Customize Items
• Custom Templates

Note that if you set the multiline property to true, you cannot use the following item properties:

• location

• locateInMenu

• menuItemTemplate

• menuItemRender

• menuItemComponent

The Toolbar component evaluates the noDataText property's value. This evaluation, however, makes the Toolbar 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-toolbar ...
    (onInitialized)="saveInstance($event)">
</dx-toolbar>

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

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

<script>
import DxToolbar from 'devextreme-vue/toolbar';

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

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

<script setup>
import DxToolbar from 'devextreme-vue/toolbar';

let toolbarInstance = null;

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

import Toolbar from 'devextreme-react/toolbar';

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

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

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

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

See Also

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

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

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

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 { DxToolbarModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

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

export default { 
    components: { 
        DxToolbar
    }, 
    // ...
    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 Toolbar from 'devextreme-react/toolbar'; 

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

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

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

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.