Toolbar Customization
Documentation
The DataGrid widget allows you to customize its toolbar using the onToolbarPreparing function. You can add new items to the toolbar or customize the existing ones. In this demo, the toolbar contains a collection of other widgets from the DevExtreme HTML5 UI Widgets library.
Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
If you have technical questions, please create a support ticket in the DevExpress Support Center.
Thank you!
We appreciate your feedback.
We appreciate your feedback.
<template>
<DxDataGrid
id="gridContainer"
:ref="gridRefName"
:data-source="orders"
:show-borders="true"
@toolbar-preparing="onToolbarPreparing($event)"
>
<DxGrouping :auto-expand-all="expanded"/>
<DxColumnChooser :enabled="true"/>
<DxLoadPanel :enabled="true"/>
<DxColumn
data-field="OrderNumber"
caption="Invoice Number"
/>
<DxColumn data-field="OrderDate"/>
<DxColumn data-field="Employee"/>
<DxColumn
data-field="CustomerStoreCity"
caption="City"
/>
<DxColumn
:group-index="0"
data-field="CustomerStoreState"
caption="State"
/>
<DxColumn
data-field="SaleAmount"
alignment="right"
format="currency"
/>
<template #totalGroupCount="{ data }">
<div class="informer">
<h2 class="count">{{ totalCount }}</h2>
<span class="name">Total Count</span>
</div>
</template>
</DxDataGrid>
</template>
<script>
import { DxDataGrid, DxColumn, DxGrouping, DxColumnChooser, DxLoadPanel } from 'devextreme-vue/data-grid';
import query from 'devextreme/data/query';
import service from './data.js';
export default {
components: {
DxDataGrid, DxColumn, DxGrouping, DxColumnChooser, DxLoadPanel
},
data() {
return {
orders: service.getOrders(),
gridRefName: 'dataGrid',
expanded: true,
totalCount: 0
};
},
created() {
this.totalCount = this.getGroupCount('CustomerStoreState');
},
methods: {
getGroupCount(groupField) {
return query(this.orders)
.groupBy(groupField)
.toArray().length;
},
onToolbarPreparing(e) {
e.toolbarOptions.items.unshift({
location: 'before',
template: 'totalGroupCount'
}, {
location: 'before',
widget: 'dxSelectBox',
options: {
width: 200,
items: [{
value: 'CustomerStoreState',
text: 'Grouping by State'
}, {
value: 'Employee',
text: 'Grouping by Employee'
}],
displayExpr: 'text',
valueExpr: 'value',
value: 'CustomerStoreState',
onValueChanged: this.groupChanged.bind(this)
}
}, {
location: 'before',
widget: 'dxButton',
options: {
width: 136,
text: 'Collapse All',
onClick: this.collapseAllClick.bind(this)
}
}, {
location: 'after',
widget: 'dxButton',
options: {
icon: 'refresh',
onClick: this.refreshDataGrid.bind(this)
}
});
},
groupChanged(e) {
this.$refs[this.gridRefName].instance.clearGrouping();
this.$refs[this.gridRefName].instance.columnOption(e.value, 'groupIndex', 0);
this.totalCount = this.getGroupCount(e.value);
},
collapseAllClick(e) {
this.expanded = !this.expanded;
e.component.option({
text: this.expanded ? 'Collapse All' : 'Expand All'
});
},
refreshDataGrid() {
this.$refs[this.gridRefName].instance.refresh();
}
}
};
</script>
<style scoped>
.dx-datagrid-header-panel {
padding: 0;
background-color: rgba(85, 149, 222, 0.6);
}
.dx-datagrid-header-panel .dx-toolbar {
margin: 0;
padding-right: 20px;
background-color: transparent;
}
.dx-datagrid-header-panel .dx-toolbar-items-container {
height: 70px;
}
.dx-datagrid-header-panel .dx-toolbar-before .dx-toolbar-item:not(:first-child) {
background-color: rgba(103, 171, 255, 0.6);
}
.dx-datagrid-header-panel .dx-toolbar-before .dx-toolbar-item:last-child {
padding-right: 10px;
}
.dx-datagrid-header-panel .dx-selectbox {
margin: 17px 10px;
}
.dx-datagrid-header-panel .dx-button {
margin: 17px 0;
}
.informer {
height: 70px;
width: 130px;
text-align: center;
color: #fff;
}
.count {
padding-top: 15px;
line-height: 27px;
margin: 0;
}
</style>
import Vue from 'vue';
import App from './App.vue';
new Vue({
el: '#app',
components: { App },
template: '<App/>'
});
<!DOCTYPE html>
<html>
<head>
<title>DevExtreme Demo</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.1.8/css/dx.common.css" />
<link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/20.1.8/css/dx.light.css" />
<script src="https://unpkg.com/core-js@2.4.1/client/shim.min.js"></script>
<script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script>
<script type="text/javascript" src="config.js"></script>
<script type="text/javascript">
System.import('./index.js');
</script>
</head>
<body class="dx-viewport">
<div class="demo-container">
<div id="app"/>
</div>
</body>
</html>
let orders = [{
'ID' : 1,
'OrderNumber' : 35703,
'OrderDate' : new Date(2014, 3, 10),
'SaleAmount' : 11800,
'Terms' : '15 Days',
'TotalAmount' : 12175,
'CustomerStoreState' : 'California',
'CustomerStoreCity' : 'Los Angeles',
'Employee' : 'Harv Mudd'
}, {
'ID' : 4,
'OrderNumber' : 35711,
'OrderDate' : new Date(2014, 0, 12),
'SaleAmount' : 16050,
'Terms' : '15 Days',
'TotalAmount' : 16550,
'CustomerStoreState' : 'California',
'CustomerStoreCity' : 'San Jose',
'Employee' : 'Jim Packard'
}, {
'ID' : 5,
'OrderNumber' : 35714,
'OrderDate' : new Date(2014, 0, 22),
'SaleAmount' : 14750,
'Terms' : '15 Days',
'TotalAmount' : 15250,
'CustomerStoreState' : 'Nevada',
'CustomerStoreCity' : 'Las Vegas',
'Employee' : 'Harv Mudd'
}, {
'ID' : 7,
'OrderNumber' : 35983,
'OrderDate' : new Date(2014, 1, 7),
'SaleAmount' : 3725,
'Terms' : '15 Days',
'TotalAmount' : 3850,
'CustomerStoreState' : 'Colorado',
'CustomerStoreCity' : 'Denver',
'Employee' : 'Todd Hoffman'
}, {
'ID' : 9,
'OrderNumber' : 36987,
'OrderDate' : new Date(2014, 2, 11),
'SaleAmount' : 14200,
'Terms' : '15 Days',
'TotalAmount' : 14800,
'CustomerStoreState' : 'Utah',
'CustomerStoreCity' : 'Salt Lake City',
'Employee' : 'Clark Morgan'
}, {
'ID' : 11,
'OrderNumber' : 38466,
'OrderDate' : new Date(2014, 2, 1),
'SaleAmount' : 7800,
'Terms' : '15 Days',
'TotalAmount' : 8200,
'CustomerStoreState' : 'California',
'CustomerStoreCity' : 'Los Angeles',
'Employee' : 'Harv Mudd'
}, {
'ID' : 14,
'OrderNumber' : 39420,
'OrderDate' : new Date(2014, 1, 15),
'SaleAmount' : 20500,
'Terms' : '15 Days',
'TotalAmount' : 9100,
'CustomerStoreState' : 'California',
'CustomerStoreCity' : 'San Jose',
'Employee' : 'Jim Packard'
}, {
'ID' : 15,
'OrderNumber' : 39874,
'OrderDate' : new Date(2014, 1, 4),
'SaleAmount' : 9050,
'Terms' : '30 Days',
'TotalAmount' : 19100,
'CustomerStoreState' : 'Nevada',
'CustomerStoreCity' : 'Las Vegas',
'Employee' : 'Harv Mudd'
}, {
'ID' : 18,
'OrderNumber' : 42847,
'OrderDate' : new Date(2014, 1, 15),
'SaleAmount' : 20400,
'Terms' : '30 Days',
'TotalAmount' : 20800,
'CustomerStoreState' : 'Wyoming',
'CustomerStoreCity' : 'Casper',
'Employee' : 'Todd Hoffman'
}, {
'ID' : 19,
'OrderNumber' : 43982,
'OrderDate' : new Date(2014, 4, 29),
'SaleAmount' : 6050,
'Terms' : '30 Days',
'TotalAmount' : 6250,
'CustomerStoreState' : 'Utah',
'CustomerStoreCity' : 'Salt Lake City',
'Employee' : 'Clark Morgan'
}, {
'ID' : 29,
'OrderNumber' : 56272,
'OrderDate' : new Date(2014, 1, 6),
'SaleAmount' : 15850,
'Terms' : '30 Days',
'TotalAmount' : 16350,
'CustomerStoreState' : 'Utah',
'CustomerStoreCity' : 'Salt Lake City',
'Employee' : 'Clark Morgan'
}, {
'ID' : 30,
'OrderNumber' : 57429,
'OrderDate' : new Date(2013, 11, 31),
'SaleAmount' : 11050,
'Terms' : '30 Days',
'TotalAmount' : 11400,
'CustomerStoreState' : 'Arizona',
'CustomerStoreCity' : 'Phoenix',
'Employee' : 'Clark Morgan'
}];
export default {
getOrders() {
return orders;
}
};
System.config({
transpiler: 'plugin-babel',
meta: {
'*.vue': {
loader: 'vue-loader'
},
},
paths: {
'npm:': 'https://unpkg.com/'
},
map: {
'vue': 'npm:vue@2.6.3/dist/vue.esm.browser.js',
'vue-loader': 'npm:dx-systemjs-vue-browser@latest/index.js',
'devextreme': 'npm:devextreme@20.1',
'devextreme-vue': 'npm:devextreme-vue@20.1',
'jszip': 'npm:jszip@3.1.3/dist/jszip.min.js',
'quill': 'npm:quill@1.3.7/dist/quill.js',
'devexpress-diagram': 'npm:devexpress-diagram@1.0.17',
'devexpress-gantt': 'npm:devexpress-gantt@1.0.10',
'plugin-babel': 'npm:systemjs-plugin-babel@0/plugin-babel.js',
'systemjs-babel-build': 'npm:systemjs-plugin-babel@0/systemjs-babel-browser.js'
},
packages: {
'devextreme-vue': {
main: 'index.js'
},
'devextreme': {
defaultExtension: 'js'
},
'devextreme/events/utils': {
main: 'index'
},
'devextreme/events': {
main: 'index'
},
},
babelOptions: {
sourceMaps: false,
stage0: true
}
});