Sorting
The KendoReact Data Grid enables you to sort single and multiple data-bound columns.
Getting Started
To enable sorting:
- Set the
sortable
option of the Grid. - Set the
field
option of the Grid column. - Utilize the
sort
option to apply the sorting styles and buttons to the affected columns. - Handle the
onSortChange
or theonDataStateChange
event of the Grid. TheonDataStateChange
event is recommended when the Grid will have other data operations as it provides the completedataState
in a single event. - Sort the data on the client by using our built-in methods orderBy or process. The data can also be sorted on the server by making a request using the event parameters.
The orderBy method is recommended when using the
process
method is recommended when using theonDataStateChange
event.
The following example demonstrates the minimum required configuration for sorting the Grid records.
Customize Sorting
The sorting feature of the Grid enables you to unsort the columns and sort the records by multiple columns.
- To enable the unsorting of columns, utilize the
sortable.allowUnsort
option which determines if the columns can be unsorted. - To enable the sorting of multiple columns, set the
sortable.mode
option which accepts asingle
ormultiple
value.
Reversing Sorting Order
The Grid allows you to reverse the sorting order of its columns. To apply higher priority to the column which was last sorted, place the last column at the beginning of the sorting array before you set the new state. When a column is removed from the sorting state, you do not have to reverse the items.
sortChange(event) {
const sort = event.sort;
if (sort.length >= this.state.sort.length) {
sort.unshift(sort.pop());
}
this.setState({
products: this.GetProducts(sort),
sort: sort
});
}