React Data Grid - Edit State Management

Our DataGrid component manages its edit state automatically. If your use case requires full control over the editing process, you can use the API members below to manage state manually. In this demo, we manage state with a help of the useReducer React hook.

TS JS

Backend API

import React, { useCallback, useEffect, useMemo, useReducer, } from 'react'; import DataGrid, { Column, type DataGridTypes, Editing, Pager, } from 'devextreme-react/data-grid'; import { LoadPanel } from 'devextreme-react/load-panel'; import 'whatwg-fetch'; import reducer, { State } from './reducer.ts'; import { saveChange, loadOrders, setChanges, setEditRowKey, } from './actions.ts'; const initialState: State = { data: [], changes: [], editRowKey: null, isLoading: false, }; const loadPanelPosition = { of: '#gridContainer' }; const App = () => { const [state, dispatch] = useReducer(reducer, initialState); const changesText = useMemo(() => JSON.stringify(state.changes.map((change) => ({ type: change.type, key: change.type !== 'insert' ? change.key : undefined, data: change.data, })), null, ' '), [state.changes]); useEffect(() => { loadOrders(dispatch); }, []); const onSaving = useCallback((e: DataGridTypes.SavingEvent) => { e.cancel = true; e.promise = saveChange(dispatch, e.changes[0]); }, []); const onChangesChange = useCallback((changes: DataGridTypes.DataChange[]) => { setChanges(dispatch, changes); }, []); const onEditRowKeyChange = useCallback((editRowKey) => { setEditRowKey(dispatch, editRowKey); }, []); return ( <React.Fragment> <LoadPanel position={loadPanelPosition} visible={state.isLoading} /> <DataGrid id="gridContainer" keyExpr="OrderID" dataSource={state.data} showBorders repaintChangesOnly onSaving={onSaving}> <Editing mode="row" allowAdding allowDeleting allowUpdating changes={state.changes} onChangesChange={onChangesChange} editRowKey={state.editRowKey} onEditRowKeyChange={onEditRowKeyChange} /> <Pager visible={true} /> <Column dataField="OrderID" allowEditing={false}></Column> <Column dataField="ShipName"></Column> <Column dataField="ShipCountry"></Column> <Column dataField="ShipCity"></Column> <Column dataField="ShipAddress"></Column> <Column dataField="OrderDate" dataType="date"></Column> <Column dataField="Freight"></Column> </DataGrid> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Edit Row Key:</span> <div id="editRowKey">{state.editRowKey === null ? 'null' : state.editRowKey.toString()}</div> </div> <div className="option"> <span>Changes:</span> <div id="changes">{changesText}</div> </div> </div> </React.Fragment> ); }; export default App;

import React, { useCallback, useEffect, useMemo, useReducer, } from 'react'; import DataGrid, { Column, Editing, Pager } from 'devextreme-react/data-grid'; import { LoadPanel } from 'devextreme-react/load-panel'; import 'whatwg-fetch'; import reducer from './reducer.js'; import { saveChange, loadOrders, setChanges, setEditRowKey, } from './actions.js'; const initialState = { data: [], changes: [], editRowKey: null, isLoading: false, }; const loadPanelPosition = { of: '#gridContainer' }; const App = () => { const [state, dispatch] = useReducer(reducer, initialState); const changesText = useMemo( () => JSON.stringify( state.changes.map((change) => ({ type: change.type, key: change.type !== 'insert' ? change.key : undefined, data: change.data, })), null, ' ', ), [state.changes], ); useEffect(() => { loadOrders(dispatch); }, []); const onSaving = useCallback((e) => { e.cancel = true; e.promise = saveChange(dispatch, e.changes[0]); }, []); const onChangesChange = useCallback((changes) => { setChanges(dispatch, changes); }, []); const onEditRowKeyChange = useCallback((editRowKey) => { setEditRowKey(dispatch, editRowKey); }, []); return ( <React.Fragment> <LoadPanel position={loadPanelPosition} visible={state.isLoading} /> <DataGrid id="gridContainer" keyExpr="OrderID" dataSource={state.data} showBorders repaintChangesOnly onSaving={onSaving} > <Editing mode="row" allowAdding allowDeleting allowUpdating changes={state.changes} onChangesChange={onChangesChange} editRowKey={state.editRowKey} onEditRowKeyChange={onEditRowKeyChange} /> <Pager visible={true} /> <Column dataField="OrderID" allowEditing={false} ></Column> <Column dataField="ShipName"></Column> <Column dataField="ShipCountry"></Column> <Column dataField="ShipCity"></Column> <Column dataField="ShipAddress"></Column> <Column dataField="OrderDate" dataType="date" ></Column> <Column dataField="Freight"></Column> </DataGrid> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Edit Row Key:</span> <div id="editRowKey"> {state.editRowKey === null ? 'null' : state.editRowKey.toString()} </div> </div> <div className="option"> <span>Changes:</span> <div id="changes">{changesText}</div> </div> </div> </React.Fragment> ); }; 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 { sendRequest } from './utils.ts'; const URL = 'https://js.devexpress.com/Demos/NetCore/api/DataGridWebApi'; export const FETCH_PENDING = 'FETCH_PENDING'; export const FETCH_SUCCESS = 'FETCH_SUCCESS'; export const FETCH_ERROR = 'FETCH_ERROR'; export const SAVING_PENDING = 'SAVING_PENDING'; export const SAVING_SUCCESS = 'SAVING_SUCCESS'; export const SAVING_ERROR = 'SAVING_ERROR'; export const SAVING_CANCEL = 'SAVING_CANCEL'; export const SET_CHANGES = 'SET_CHANGES'; export const SET_EDIT_ROW_KEY = 'SET_EDIT_ROW_KEY'; type dispatchType = React.Dispatch<{ type: any, payload?: any }>; export async function loadOrders(dispatch: dispatchType) { dispatch({ type: FETCH_PENDING }); try { const { data } = await sendRequest(`${URL}/Orders?skip=700`); dispatch({ type: FETCH_SUCCESS, payload: { data, }, }); } catch (err) { dispatch({ type: FETCH_ERROR }); throw err; } } export async function saveChange(dispatch: dispatchType, change: { type: any; data: any; key: any; }) { if (change && change.type) { let data; dispatch({ type: SAVING_PENDING }); try { data = await sendChange(URL, change); change.data = data; dispatch({ type: SAVING_SUCCESS, payload: { change, }, }); return data; } catch (err) { dispatch({ type: SAVING_ERROR }); throw err; } } else { dispatch({ type: SAVING_CANCEL }); return null; } } async function sendChange(url: string, change: { type: any; data: any; key: any; }) { switch (change.type) { case 'insert': return sendRequest(`${url}/InsertOrder`, 'POST', { values: JSON.stringify(change.data), }); case 'update': return sendRequest(`${url}/UpdateOrder`, 'PUT', { key: change.key, values: JSON.stringify(change.data), }); case 'remove': return sendRequest(`${url}/DeleteOrder`, 'DELETE', { key: change.key }); default: return null; } } export function setChanges(dispatch: dispatchType, changes) { dispatch({ type: SET_CHANGES, payload: changes, }); } export function setEditRowKey(dispatch: dispatchType, editRowKey) { dispatch({ type: SET_EDIT_ROW_KEY, payload: editRowKey, }); }

import applyChanges from 'devextreme/data/apply_changes'; import { DataGridTypes } from 'devextreme-react/data-grid'; import { FETCH_PENDING, FETCH_SUCCESS, FETCH_ERROR, SAVING_PENDING, SAVING_SUCCESS, SAVING_ERROR, SAVING_CANCEL, SET_CHANGES, SET_EDIT_ROW_KEY, } from './actions.ts'; export interface State { data: any[]; editRowKey: any; changes: DataGridTypes.DataChange[]; isLoading: boolean; } export default function reducer(state: State, { type, payload }) { let newData; switch (type) { case SAVING_SUCCESS: newData = applyChanges(state.data, [payload.change], { keyExpr: 'OrderID' }); return { ...state, data: newData, changes: [], editRowKey: null, isLoading: false, }; case SAVING_CANCEL: return { ...state, changes: [], editRowKey: null, }; case SET_CHANGES: return { ...state, changes: payload, }; case SET_EDIT_ROW_KEY: return { ...state, editRowKey: payload, }; case FETCH_SUCCESS: return { ...state, ...payload, isLoading: false, }; case FETCH_PENDING: case SAVING_PENDING: return { ...state, isLoading: true, }; case FETCH_ERROR: case SAVING_ERROR: return { ...state, isLoading: false, }; default: return state; } }

export async function sendRequest(url: string, method = 'GET', data = {}) { const params = Object.keys(data) .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`) .join('&'); const result = await fetch(url, { method, body: params || null, headers: method === 'GET' ? {} : { 'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8', }, credentials: 'include', }); if (result.ok) { const text = await result.text(); return text && JSON.parse(text); } const json = await result.json(); throw json.Message; }

import { sendRequest } from './utils.js'; const URL = 'https://js.devexpress.com/Demos/NetCore/api/DataGridWebApi'; export const FETCH_PENDING = 'FETCH_PENDING'; export const FETCH_SUCCESS = 'FETCH_SUCCESS'; export const FETCH_ERROR = 'FETCH_ERROR'; export const SAVING_PENDING = 'SAVING_PENDING'; export const SAVING_SUCCESS = 'SAVING_SUCCESS'; export const SAVING_ERROR = 'SAVING_ERROR'; export const SAVING_CANCEL = 'SAVING_CANCEL'; export const SET_CHANGES = 'SET_CHANGES'; export const SET_EDIT_ROW_KEY = 'SET_EDIT_ROW_KEY'; export async function loadOrders(dispatch) { dispatch({ type: FETCH_PENDING }); try { const { data } = await sendRequest(`${URL}/Orders?skip=700`); dispatch({ type: FETCH_SUCCESS, payload: { data, }, }); } catch (err) { dispatch({ type: FETCH_ERROR }); throw err; } } export async function saveChange(dispatch, change) { if (change && change.type) { let data; dispatch({ type: SAVING_PENDING }); try { data = await sendChange(URL, change); change.data = data; dispatch({ type: SAVING_SUCCESS, payload: { change, }, }); return data; } catch (err) { dispatch({ type: SAVING_ERROR }); throw err; } } else { dispatch({ type: SAVING_CANCEL }); return null; } } async function sendChange(url, change) { switch (change.type) { case 'insert': return sendRequest(`${url}/InsertOrder`, 'POST', { values: JSON.stringify(change.data), }); case 'update': return sendRequest(`${url}/UpdateOrder`, 'PUT', { key: change.key, values: JSON.stringify(change.data), }); case 'remove': return sendRequest(`${url}/DeleteOrder`, 'DELETE', { key: change.key }); default: return null; } } export function setChanges(dispatch, changes) { dispatch({ type: SET_CHANGES, payload: changes, }); } export function setEditRowKey(dispatch, editRowKey) { dispatch({ type: SET_EDIT_ROW_KEY, payload: editRowKey, }); }

import applyChanges from 'devextreme/data/apply_changes'; import { FETCH_PENDING, FETCH_SUCCESS, FETCH_ERROR, SAVING_PENDING, SAVING_SUCCESS, SAVING_ERROR, SAVING_CANCEL, SET_CHANGES, SET_EDIT_ROW_KEY, } from './actions.js'; export default function reducer(state, { type, payload }) { let newData; switch (type) { case SAVING_SUCCESS: newData = applyChanges(state.data, [payload.change], { keyExpr: 'OrderID' }); return { ...state, data: newData, changes: [], editRowKey: null, isLoading: false, }; case SAVING_CANCEL: return { ...state, changes: [], editRowKey: null, }; case SET_CHANGES: return { ...state, changes: payload, }; case SET_EDIT_ROW_KEY: return { ...state, editRowKey: payload, }; case FETCH_SUCCESS: return { ...state, ...payload, isLoading: false, }; case FETCH_PENDING: case SAVING_PENDING: return { ...state, isLoading: true, }; case FETCH_ERROR: case SAVING_ERROR: return { ...state, isLoading: false, }; default: return state; } }

export async function sendRequest(url, method = 'GET', data = {}) { const params = Object.keys(data) .map((key) => `${encodeURIComponent(key)}=${encodeURIComponent(data[key])}`) .join('&'); const result = await fetch(url, { method, body: params || null, headers: method === 'GET' ? {} : { 'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8', }, credentials: 'include', }); if (result.ok) { const text = await result.text(); return text && JSON.parse(text); } const json = await result.json(); throw json.Message; }

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" /> <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>

#gridContainer { height: 440px; } .options { padding: 20px; margin-top: 20px; background-color: rgba(191, 191, 191, 0.15); } .caption { margin-bottom: 10px; font-weight: 500; font-size: 18px; } .option { margin-bottom: 10px; } .option > span { position: relative; margin-right: 14px; } .option > div { display: inline-block; font-weight: bold; }

Component Properties

editing.editRowKey
The key for the row being edited.
editing.editColumnName
The name or data field of the column being edited.
editing.changes
Pending row changes.

Bind these properties to state props and set the props to change edit state at runtime. In this demo, we bind the editRowKey and changes properties and use the corresponding on_OptionName_Change event handlers to set the bound props.

Utility Method

DevExpress.data.applyChanges(data, changes, options)
Applies an array of changes to a source data array.

Event Handlers

onSaving / onSaved
Functions that are called before / after pending row changes are saved via the UI or programmatically.
onEditCanceling / onEditCanceled
Functions that are called before / after editing is canceled and pending row changes are discarded.

Use these functions to perform custom actions. In this demo, the onSaving function sends pending changes to a server. The function's parameter e contains fields for this capability. To implement the same in your application, follow these steps:

Disable built-in edit state management
Set the e.cancel field to true.
Send a request to the server
Pending changes are stored in the e.changes array. This array has only a single element in all edit modes, except for batch. Check if this element is not empty and send it to the server (see the saveChange action in actions.js).
Apply the same changes to the DataGrid's data source and reset edit state
If the server successfully saves changes, call the applyChanges method to save the same changes in the DataGrid's data source. Assign null to the editRowKey and an empty array to the changes property. This resets edit state (see the SAVING_SUCCESS handler in reducer.js).