React Data Grid - Sorting

The DataGrid component can sort values by a single or multiple columns. Use the sorting.mode property to specify the sort mode.

TS JS

Backend API

import React, { useCallback, useRef, useState } from 'react'; import DataGrid, { Column, Sorting } from 'devextreme-react/data-grid'; import CheckBox from 'devextreme-react/check-box'; import { employees } from './data.ts'; const App = () => { const [positionDisableSorting, setPositionDisableSorting] = useState(false); const dataGridRef = useRef(null); const onPositionSortingChanged = useCallback(() => { setPositionDisableSorting((previousPositionDisableSorting) => !previousPositionDisableSorting); dataGridRef.current.instance().columnOption(5, 'sortOrder', undefined); }, []); return ( <div> <DataGrid dataSource={employees} keyExpr="ID" showBorders={true} ref={dataGridRef} > <Sorting mode="multiple" /> <Column dataField="Prefix" caption="Title" width={100} defaultSortOrder="asc" /> <Column dataField="FirstName" defaultSortOrder="asc" /> <Column dataField="LastName" /> <Column dataField="City" /> <Column dataField="State" /> <Column dataField="Position" allowSorting={!positionDisableSorting} width={130} /> <Column dataField="HireDate" dataType="date" /> </DataGrid> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="Disable Sorting for the Position Column" value={positionDisableSorting} onValueChanged={onPositionSortingChanged} /> </div> </div> </div> ); }; export default App;

import React, { useCallback, useRef, useState } from 'react'; import DataGrid, { Column, Sorting } from 'devextreme-react/data-grid'; import CheckBox from 'devextreme-react/check-box'; import { employees } from './data.js'; const App = () => { const [positionDisableSorting, setPositionDisableSorting] = useState(false); const dataGridRef = useRef(null); const onPositionSortingChanged = useCallback(() => { setPositionDisableSorting((previousPositionDisableSorting) => !previousPositionDisableSorting); dataGridRef.current.instance().columnOption(5, 'sortOrder', undefined); }, []); return ( <div> <DataGrid dataSource={employees} keyExpr="ID" showBorders={true} ref={dataGridRef} > <Sorting mode="multiple" /> <Column dataField="Prefix" caption="Title" width={100} defaultSortOrder="asc" /> <Column dataField="FirstName" defaultSortOrder="asc" /> <Column dataField="LastName" /> <Column dataField="City" /> <Column dataField="State" /> <Column dataField="Position" allowSorting={!positionDisableSorting} width={130} /> <Column dataField="HireDate" dataType="date" /> </DataGrid> <div className="options"> <div className="caption">Options</div> <div className="option"> <CheckBox text="Disable Sorting for the Position Column" value={positionDisableSorting} onValueChanged={onPositionSortingChanged} /> </div> </div> </div> ); }; export default App;

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );

export const employees = [{ ID: 1, FirstName: 'John', LastName: 'Heart', Phone: '(213) 555-9392', Prefix: 'Mr.', Position: 'CEO', BirthDate: '1964-03-16', HireDate: '1995-01-15', Email: 'jheart@dx-email.com', Address: '351 S Hill St.', City: 'Los Angeles', StateID: 5, State: 'California', HomePhone: '(213) 555-9208', Skype: 'jheartDXskype', }, { ID: 2, FirstName: 'Olivia', LastName: 'Peyton', Phone: '(310) 555-2728', Prefix: 'Mrs.', Position: 'Sales Assistant', BirthDate: '1981-06-03', HireDate: '2012-05-14', Email: 'oliviap@dx-email.com', Address: '807 W Paseo Del Mar', City: 'Los Angeles', StateID: 5, State: 'California', HomePhone: '(310) 555-4547', Skype: 'oliviapDXskype', }, { ID: 3, FirstName: 'Robert', LastName: 'Reagan', Phone: '(818) 555-2387', Prefix: 'Mr.', Position: 'CMO', BirthDate: '1974-09-07', HireDate: '2002-11-08', Email: 'robertr@dx-email.com', Address: '4 Westmoreland Pl.', City: 'Bentonville', StateID: 4, State: 'Arkansas', HomePhone: '(818) 555-2438', Skype: 'robertrDXskype', }, { ID: 4, FirstName: 'Greta', LastName: 'Sims', Phone: '(818) 555-6546', Prefix: 'Ms.', Position: 'HR Manager', BirthDate: '1977-11-22', HireDate: '1998-04-23', Email: 'gretas@dx-email.com', Address: '1700 S Grandview Dr.', City: 'Atlanta', StateID: 11, State: 'Georgia', HomePhone: '(818) 555-0976', Skype: 'gretasDXskype', }, { ID: 5, FirstName: 'Brett', LastName: 'Wade', Phone: '(626) 555-0358', Prefix: 'Mr.', Position: 'IT Manager', BirthDate: '1968-12-01', HireDate: '2009-03-06', Email: 'brettw@dx-email.com', Address: '1120 Old Mill Rd.', City: 'Boise', StateID: 13, State: 'Idaho', HomePhone: '(626) 555-5985', Skype: 'brettwDXskype', }, { ID: 6, FirstName: 'Sandra', LastName: 'Johnson', Phone: '(562) 555-2082', Prefix: 'Mrs.', Position: 'Controller', BirthDate: '1974-11-15', HireDate: '2005-05-11', Email: 'sandraj@dx-email.com', Address: '4600 N Virginia Rd.', City: 'Beaver', StateID: 44, State: 'Utah', HomePhone: '(562) 555-8272', Skype: 'sandrajDXskype', }, { ID: 7, FirstName: 'Kevin', LastName: 'Carter', Phone: '(213) 555-2840', Prefix: 'Mr.', Position: 'Shipping Manager', BirthDate: '1978-01-09', HireDate: '2009-08-11', Email: 'kevinc@dx-email.com', Address: '424 N Main St.', City: 'San Diego', StateID: 5, State: 'California', HomePhone: '(213) 555-8038', Skype: 'kevincDXskype', }, { ID: 8, FirstName: 'Cynthia', LastName: 'Stanwick', Phone: '(818) 555-6655', Prefix: 'Ms.', Position: 'HR Assistant', BirthDate: '1985-06-05', HireDate: '2008-03-24', Email: 'cindys@dx-email.com', Address: '2211 Bonita Dr.', City: 'Little Rock', StateID: 4, State: 'Arkansas', HomePhone: '(818) 555-6808', Skype: 'cindysDXskype', }, { ID: 9, FirstName: 'Kent', LastName: 'Samuelson', Phone: '(562) 555-9282', Prefix: 'Dr.', Position: 'Ombudsman', BirthDate: '1972-09-11', HireDate: '2009-04-22', Email: 'kents@dx-email.com', Address: '12100 Mora Dr', City: 'St. Louis', StateID: 26, State: 'Missouri', HomePhone: '(562) 555-1328', Skype: 'kentsDXskype', }, { ID: 10, FirstName: 'Taylor', LastName: 'Riley', Phone: '(310) 555-7276', Prefix: 'Mr.', Position: 'Network Admin', BirthDate: '1982-08-14', HireDate: '2012-04-14', Email: 'taylorr@dx-email.com', Address: '7776 Torreyson Dr', City: 'San Jose', StateID: 5, State: 'California', HomePhone: '(310) 555-9712', Skype: 'taylorrDXskype', }];

import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));

export const employees = [ { ID: 1, FirstName: 'John', LastName: 'Heart', Phone: '(213) 555-9392', Prefix: 'Mr.', Position: 'CEO', BirthDate: '1964-03-16', HireDate: '1995-01-15', Email: 'jheart@dx-email.com', Address: '351 S Hill St.', City: 'Los Angeles', StateID: 5, State: 'California', HomePhone: '(213) 555-9208', Skype: 'jheartDXskype', }, { ID: 2, FirstName: 'Olivia', LastName: 'Peyton', Phone: '(310) 555-2728', Prefix: 'Mrs.', Position: 'Sales Assistant', BirthDate: '1981-06-03', HireDate: '2012-05-14', Email: 'oliviap@dx-email.com', Address: '807 W Paseo Del Mar', City: 'Los Angeles', StateID: 5, State: 'California', HomePhone: '(310) 555-4547', Skype: 'oliviapDXskype', }, { ID: 3, FirstName: 'Robert', LastName: 'Reagan', Phone: '(818) 555-2387', Prefix: 'Mr.', Position: 'CMO', BirthDate: '1974-09-07', HireDate: '2002-11-08', Email: 'robertr@dx-email.com', Address: '4 Westmoreland Pl.', City: 'Bentonville', StateID: 4, State: 'Arkansas', HomePhone: '(818) 555-2438', Skype: 'robertrDXskype', }, { ID: 4, FirstName: 'Greta', LastName: 'Sims', Phone: '(818) 555-6546', Prefix: 'Ms.', Position: 'HR Manager', BirthDate: '1977-11-22', HireDate: '1998-04-23', Email: 'gretas@dx-email.com', Address: '1700 S Grandview Dr.', City: 'Atlanta', StateID: 11, State: 'Georgia', HomePhone: '(818) 555-0976', Skype: 'gretasDXskype', }, { ID: 5, FirstName: 'Brett', LastName: 'Wade', Phone: '(626) 555-0358', Prefix: 'Mr.', Position: 'IT Manager', BirthDate: '1968-12-01', HireDate: '2009-03-06', Email: 'brettw@dx-email.com', Address: '1120 Old Mill Rd.', City: 'Boise', StateID: 13, State: 'Idaho', HomePhone: '(626) 555-5985', Skype: 'brettwDXskype', }, { ID: 6, FirstName: 'Sandra', LastName: 'Johnson', Phone: '(562) 555-2082', Prefix: 'Mrs.', Position: 'Controller', BirthDate: '1974-11-15', HireDate: '2005-05-11', Email: 'sandraj@dx-email.com', Address: '4600 N Virginia Rd.', City: 'Beaver', StateID: 44, State: 'Utah', HomePhone: '(562) 555-8272', Skype: 'sandrajDXskype', }, { ID: 7, FirstName: 'Kevin', LastName: 'Carter', Phone: '(213) 555-2840', Prefix: 'Mr.', Position: 'Shipping Manager', BirthDate: '1978-01-09', HireDate: '2009-08-11', Email: 'kevinc@dx-email.com', Address: '424 N Main St.', City: 'San Diego', StateID: 5, State: 'California', HomePhone: '(213) 555-8038', Skype: 'kevincDXskype', }, { ID: 8, FirstName: 'Cynthia', LastName: 'Stanwick', Phone: '(818) 555-6655', Prefix: 'Ms.', Position: 'HR Assistant', BirthDate: '1985-06-05', HireDate: '2008-03-24', Email: 'cindys@dx-email.com', Address: '2211 Bonita Dr.', City: 'Little Rock', StateID: 4, State: 'Arkansas', HomePhone: '(818) 555-6808', Skype: 'cindysDXskype', }, { ID: 9, FirstName: 'Kent', LastName: 'Samuelson', Phone: '(562) 555-9282', Prefix: 'Dr.', Position: 'Ombudsman', BirthDate: '1972-09-11', HireDate: '2009-04-22', Email: 'kents@dx-email.com', Address: '12100 Mora Dr', City: 'St. Louis', StateID: 26, State: 'Missouri', HomePhone: '(562) 555-1328', Skype: 'kentsDXskype', }, { ID: 10, FirstName: 'Taylor', LastName: 'Riley', Phone: '(310) 555-7276', Prefix: 'Mr.', Position: 'Network Admin', BirthDate: '1982-08-14', HireDate: '2012-04-14', Email: 'taylorr@dx-email.com', Address: '7776 Torreyson Dr', City: 'San Jose', StateID: 5, State: 'California', HomePhone: '(310) 555-9712', Skype: 'taylorrDXskype', }, ];

<!DOCTYPE html> <html lang="en"> <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=5.0" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.6/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://cdn.jsdelivr.net/npm/core-js@2.6.12/client/shim.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

.options { padding: 20px; margin-top: 20px; background-color: rgba(191, 191, 191, 0.15); } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; }

Single sort mode
A user can click the column header to sort by this column and click it again to change the sort order (ascending or descending). An arrow icon in the column's header indicates the sort order.
Multiple sort mode
A user can hold the Shift key and click column headers in the order the user wants to apply sorting. A number in the column's header indicates the sort index. To cancel a column's sort settings, a user should hold the Ctrl key and click the column header.

A user can also apply or cancel sort settings in the column header's context menu. To disallow a user to sort by a particular column, set the column's allowSorting property to false.

To specify the initial sort settings, use the column's sortOrder and sortIndex properties. You can also use these properties to change sort settings at runtime, as shown in this demo.