JavaScript/jQuery DataGrid - toolbar.items
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:
index.js- $(function(){
- $("#dataGridContainer").dxDataGrid({
- // ...
- editing: {
- allowAdding: true
- },
- columnChooser: {
- enabled: true
- },
- toolbar: {
- items: [ "addRowButton", {
- name: "columnChooserButton",
- locateInMenu: "auto",
- }]
- }
- });
- });
IMPORTANTThe DataGrid does not display controls missing from the items[] array. Ensure that this array includes controls for all enabled features.DevExtreme components
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
- }
- }]
- }
- });
- });
Custom controls
To use a custom control, specify a template for it.
html
The DataGrid component evaluates the html property's value. This evaluation, however, makes the DataGrid potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.
You can use the text property as a safe alternative.
location
Whatever template you use for UI component items (default or a custom) will be located according to the value specified for the location field in the item data source object.
See Also
menuItemTemplate
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a jQuery object of the template's container.
- Assign a DOM Node of the template's container.
- Assign a function that returns the jQuery object or a DOM Node of the template's container.
- $(function() {
- $("#toolbar").dxToolbar({
- items: [{
- // ...
- menuItemTemplate (data, index) {
- return $(`<div><i class='dx-icon-favorites'></i>${data.options.text}</div>`);
- }
- }],
- });
- });
See Also
options
- $('#toolbar').dxToolbar({
- items: [{
- // ...
- widget: 'dxCheckBox',
- options: {
- text: 'Show IDs'
- },
- }]
- });
See Also
template
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- Assign a jQuery object of the template's container.
- Assign a DOM Node of the template's container.
- Assign a function that returns the jQuery object or a DOM Node of the template's container.
The following example adds a custom item to the component. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.
- $(function() {
- $("#dataGridContainer").dxDataGrid({
- // ...
- toolbar: {
- items: [
- {
- // ...
- template: '<div>Custom Item</div>'
- }
- ]
- }
- });
- });
See Also
widget
A UI component that presents a toolbar item. To configure it, use the options object.