React Data Grid - Custom Data Source

DevExtreme provides the CustomStore component to load and edit data from a custom data source. In this demo, the CustomStore fetches data from a custom remote server and displays it in the DataGrid.

TS JS

Backend API

import React from 'react'; import DataGrid, { Column, Paging, Pager } from 'devextreme-react/data-grid'; import { CustomStore } from 'devextreme-react/common/data'; import 'whatwg-fetch'; function isNotEmpty(value: string | undefined | null) { return value !== undefined && value !== null && value !== ''; } const store = new CustomStore({ key: 'OrderNumber', async load(loadOptions) { const paramNames = [ 'skip', 'take', 'requireTotalCount', 'requireGroupCount', 'sort', 'filter', 'totalSummary', 'group', 'groupSummary', ]; const queryString = paramNames .filter((paramName) => isNotEmpty(loadOptions[paramName])) .map((paramName) => `${paramName}=${JSON.stringify(loadOptions[paramName])}`) .join('&'); try { const response = await fetch(`https://js.devexpress.com/Demos/WidgetsGalleryDataService/api/orders?${queryString}`); const result = await response.json(); return { data: result.data, totalCount: result.totalCount, summary: result.summary, groupCount: result.groupCount, }; } catch (err) { throw new Error('Data Loading Error'); } }, }); const allowedPageSizes = [8, 12, 20]; const App = () => ( <DataGrid dataSource={store} showBorders={true} remoteOperations={true} > <Column dataField="OrderNumber" dataType="number" /> <Column dataField="OrderDate" dataType="date" /> <Column dataField="StoreCity" dataType="string" /> <Column dataField="StoreState" dataType="string" /> <Column dataField="Employee" dataType="string" /> <Column dataField="SaleAmount" dataType="number" format="currency" /> <Paging defaultPageSize={12} /> <Pager visible={true} showPageSizeSelector={true} allowedPageSizes={allowedPageSizes} /> </DataGrid> ); export default App;

import React from 'react'; import DataGrid, { Column, Paging, Pager } from 'devextreme-react/data-grid'; import { CustomStore } from 'devextreme-react/common/data'; import 'whatwg-fetch'; function isNotEmpty(value) { return value !== undefined && value !== null && value !== ''; } const store = new CustomStore({ key: 'OrderNumber', async load(loadOptions) { const paramNames = [ 'skip', 'take', 'requireTotalCount', 'requireGroupCount', 'sort', 'filter', 'totalSummary', 'group', 'groupSummary', ]; const queryString = paramNames .filter((paramName) => isNotEmpty(loadOptions[paramName])) .map((paramName) => `${paramName}=${JSON.stringify(loadOptions[paramName])}`) .join('&'); try { const response = await fetch( `https://js.devexpress.com/Demos/WidgetsGalleryDataService/api/orders?${queryString}`, ); const result = await response.json(); return { data: result.data, totalCount: result.totalCount, summary: result.summary, groupCount: result.groupCount, }; } catch (err) { throw new Error('Data Loading Error'); } }, }); const allowedPageSizes = [8, 12, 20]; const App = () => ( <DataGrid dataSource={store} showBorders={true} remoteOperations={true} > <Column dataField="OrderNumber" dataType="number" /> <Column dataField="OrderDate" dataType="date" /> <Column dataField="StoreCity" dataType="string" /> <Column dataField="StoreState" dataType="string" /> <Column dataField="Employee" dataType="string" /> <Column dataField="SaleAmount" dataType="number" format="currency" /> <Paging defaultPageSize={12} /> <Pager visible={true} showPageSizeSelector={true} allowedPageSizes={allowedPageSizes} /> </DataGrid> ); export default App;

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

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

<!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" /> <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> <link rel="stylesheet" type="text/css" href="styles.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>

The communication between the CustomStore and the server is organized as follows:

The CustomStore sends data processing settings to the server (see the load function in the code below).
The server applies these settings to data and returns the processed dataset (you should write the server-side code for this).

Each setting has information about a data operation (sorting, filtering, etc.) and is present only if this operation is declared as remote in the DataGrid's remoteOperations property. If your server does not support a certain operation, do not declare it as remote to perform it on the client.

For more information about the communication between the client and server in DevExtreme, refer to the following help topic: Server-Side Data Processing.

If your server does not support any data operations, set remoteOperations to false and implement the load function as described in the following help topic: Client-Side Data Processing.

A 1-Click Solution for CRUD Web API Services with Role-based Access Control via EF Core

If you target .NET for your backend API, be sure to check out Web API Service and register your free copy today. The Solution Wizard scaffolds an OData v4 Web API Service (.NET 6+) with integrated authorization & CRUD operations powered by EF Core ORM. You can use OAuth2, JWT or custom authentication strategies alongside tools like Postman or Swagger (OpenAPI) for API testing. The built-in Web API Service also filters out secured server data based on permissions granted to users. Advanced/enterprise functions include audit trail, endpoints to download reports, file attachments, check validation, obtain localized captions, etc.

To use the free Solution Wizard (which creates the Web API Service), run the Universal Component Installer from the DevExpress Download Manager and use our predefined template in Visual Studio 2022+.

Read Tutorial | View Examples: JavaScript (DevExtreme) & JavaScript (Svelte) | Watch Videos