JavaScript/jQuery DataGrid - toolbar

View Demo

See Also

• onToolbarPreparing

The toolbar can contain the following elements as items:

• Predefined controls
  Predefined controls appear on the toolbar depending on whether a specific DataGrid feature is enabled. The following table illustrates the dependency:

  Control Name	Image	Prerequisites
  addRowButton		editing.allowAdding is true
  applyFilterButton		filterRow.visible is true and filterRow.applyFilter is set to "onClick"
  columnChooserButton		columnChooser.enabled is true
  revertButton		editing.mode is set to "batch"
  saveButton		editing.mode is set to "batch" and editing.allowUpdating is true
  searchPanel		searchPanel.visible is true
  exportButton		The export feature is configured.
  groupPanel		groupPanel.visible is set to true or "auto"

  If you need to customize a predefined control, add an object to the items[] array. This object must contain the control's name and properties that you want to customize. If a control does not need customization, simply include its name in the toolbar.items[] array.

  The example below customizes the Column Chooser button, adds an Add Row button, and enables the corresponding DataGrid features:

  jQuery

  index.js

  $(function(){
      $("#dataGridContainer").dxDataGrid({
          // ...
          editing: {
              allowAdding: true
          },
          columnChooser: {
              enabled: true
          },
          toolbar: {
              items: [ "addRowButton", {
                  name: "columnChooserButton",      
                  locateInMenu: "auto",
              }]  
          }
      });
  });

  Angular

  app.component.html

  app.module.ts

  <dx-data-grid ... >
      <dxo-editing [allowAdding]="true"></dxo-editing>
      <dxo-column-chooser [enabled]="true"></dxo-column-chooser>
      <dxo-toolbar>
          <dxi-item name="addRowButton"></dxi-item>
          <dxi-item 
              name="columnChooserButton"
              locateInMenu="auto"
              location="after">
          </dxi-item>
      </dxo-toolbar>
  </dx-data-grid>

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

  Vue

  App.vue

  <template>
      <DxDataGrid ... >
          <DxEditing :allow-adding="true" />
          <DxColumnChooser :enabled="true"/>
          <DxToolbar>
              <DxItem name="addRowButton" />
              <DxItem
                  name="columnChooserButton"
                  locate-in-menu="auto"
                  location="after"
              />
          </DxToolbar>
      </DxDataGrid>
  </template>
  <script>
  import { DxDataGrid, DxEditing, DxColumnChooser, DxToolbar, DxItem } from 'devextreme-vue/data-grid';
  
  export default {
      components: {
          DxDataGrid,
          DxEditing,
          DxToolbar, 
          DxItem,
          DxColumnChooser
      }
  };
  </script>

  React

  App.js

  import DataGrid, { Editing, Toolbar, Item, ColumnChooser } from 'devextreme-react/data-grid';
  // ...
  function App() {
      return (
          <DataGrid ... >
              <Editing allowAdding={true} />
              <ColumnChooser enabled={true} />
              <Toolbar>
                  <Item name="addRowButton" />
                  <Item
                      name="columnChooserButton"
                      locateInMenu="auto"
                      location="after"
                  />
              </Toolbar>
          </DataGrid>
      );
  }

  IMPORTANT

  The DataGrid does not display controls missing from the items[] array. Ensure that this array includes controls for all enabled features.

• DevExtreme components

  jQuery

  You can use DevExtreme components as toolbar items. Set the widget property to specify the component that you want to use and configure the component's options:

  index.js

  $(function(){
      $("#dataGridContainer").dxDataGrid({
          // ...
          toolbar: {
              items: [{
                  widget: "dxSelectBox",
                  options: {
                      // SelectBox properties are specified here
                  }
              }]  
          }
      });
  });

  Angular

  You can use DevExtreme components as toolbar items. Declare a dxi-item element to add a supported component:

  app.component.html

  app.module.ts

  <dx-data-grid ... >
      <dxo-toolbar>
          <dxi-item>
              <dx-select-box>
                  <!-- SelectBox properties are specified here -->
              </dx-select-box>
          </dxi-item>
      </dxo-toolbar>
  </dx-data-grid>

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

  Vue

  You can use DevExtreme components as toolbar items. Declare a DxItem element to add a supported component:

  App.vue

  <template>
      <DxDataGrid ... >
          <DxToolbar>
              <DxItem>
                  <DxSelectBox>
                      <!-- SelectBox properties are specified here -->
                  </DxSelectBox>
              </DxItem>
          </DxToolbar>
      </DxDataGrid>
  </template>
  <script>
  import { DxDataGrid, DxToolbar, DxItem } from 'devextreme-vue/data-grid';
  import { DxSelectBox } from 'devextreme-vue/select-box';
  
  export default {
      components: {
          DxDataGrid, 
          DxToolbar, 
          DxItem,
          DxSelectBox
      }
  };
  </script>

  React

  You can use DevExtreme components as toolbar items. Declare an Item element to add a supported component:

  App.js

  import { SelectBox } from 'devextreme-react/select-box';
  import DataGrid, { Toolbar, Item } from 'devextreme-react/data-grid';
  // ...
  function App() {
      return (
          <DataGrid ... >
              <Toolbar>
                  <Item>
                      <SelectBox>
                          {/* SelectBox properties are specified here */}
                      </SelectBox>
                  </Item>
              </Toolbar>
          </DataGrid>
      );
  }

• Custom controls
  To use a custom control, specify a template for it.

View Demo

This property can have one of the following values: