React Data Grid - Collaborative Editing

Multiple users can edit the DataGrid's data in real-time. In this demo, changes made in one DataGrid are broadcasted to the other DataGrid via the SignalR service.

TS JS

Backend API

import React, { useEffect } from 'react'; import { HubConnectionBuilder, HttpTransportType } from '@aspnet/signalr'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; import Guid from 'devextreme/core/guid'; import Grid from './Grid.tsx'; const BASE_PATH = 'https://js.devexpress.com/Demos/NetCore/'; const url = `${BASE_PATH}api/DataGridCollaborativeEditing`; const groupId = new Guid().toString(); interface Change { type: 'insert' | 'update' | 'remove'; data?: any; key?: any; } const createStore = () => AspNetData.createStore({ key: 'ID', loadUrl: url, insertUrl: url, updateUrl: url, deleteUrl: url, onBeforeSend(operation, ajaxSettings) { ajaxSettings.data.groupId = groupId; }, }); const store1 = createStore(); const store2 = createStore(); const updateStores = (events: Change[]) => { store1.push(events); store2.push(events); }; const App = () => { useEffect(() => { const hubUrl = `${BASE_PATH}dataGridCollaborativeEditingHub?GroupId=${groupId}`; const connection = new HubConnectionBuilder() .withUrl(hubUrl, { skipNegotiation: true, transport: HttpTransportType.WebSockets, }) .build(); connection.start() .then(() => { connection.on('update', (key, data) => { updateStores([{ type: 'update', key, data }]); }); connection.on('insert', (data) => { updateStores([{ type: 'insert', data }]); }); connection.on('remove', (key) => { updateStores([{ type: 'remove', key }]); }); }); }, []); return ( <div className="tables"> <div className="column"> <Grid dataSource={store1} /> </div> <div className="column"> <Grid dataSource={store2} /> </div> </div> ); }; export default App;

import React, { useEffect } from 'react'; import { HubConnectionBuilder, HttpTransportType } from '@aspnet/signalr'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; import Guid from 'devextreme/core/guid'; import Grid from './Grid.js'; const BASE_PATH = 'https://js.devexpress.com/Demos/NetCore/'; const url = `${BASE_PATH}api/DataGridCollaborativeEditing`; const groupId = new Guid().toString(); const createStore = () => AspNetData.createStore({ key: 'ID', loadUrl: url, insertUrl: url, updateUrl: url, deleteUrl: url, onBeforeSend(operation, ajaxSettings) { ajaxSettings.data.groupId = groupId; }, }); const store1 = createStore(); const store2 = createStore(); const updateStores = (events) => { store1.push(events); store2.push(events); }; const App = () => { useEffect(() => { const hubUrl = `${BASE_PATH}dataGridCollaborativeEditingHub?GroupId=${groupId}`; const connection = new HubConnectionBuilder() .withUrl(hubUrl, { skipNegotiation: true, transport: HttpTransportType.WebSockets, }) .build(); connection.start().then(() => { connection.on('update', (key, data) => { updateStores([{ type: 'update', key, data }]); }); connection.on('insert', (data) => { updateStores([{ type: 'insert', data }]); }); connection.on('remove', (key) => { updateStores([{ type: 'remove', key }]); }); }); }, []); return ( <div className="tables"> <div className="column"> <Grid dataSource={store1} /> </div> <div className="column"> <Grid dataSource={store2} /> </div> </div> ); }; export default App;

import React from 'react'; import DataGrid, { Column, Editing, Paging, RequiredRule, RangeRule, Lookup, } from 'devextreme-react/data-grid'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; const maxDate = new Date(3000, 0); const statesStore = AspNetData.createStore({ key: 'ID', loadUrl: 'https://js.devexpress.com/Demos/NetCore/api/DataGridStatesLookup', }); const Grid = (props) => ( <DataGrid dataSource={props.dataSource} height={600} showBorders={true} repaintChangesOnly={true} highlightChanges={true} > <Paging enabled={false} /> <Editing mode="cell" refreshMode="reshape" allowUpdating={true} allowDeleting={true} allowAdding={true} useIcons={true} /> <Column dataField="Prefix" caption="Title" width={50} > <RequiredRule /> </Column> <Column dataField="FirstName" > <RequiredRule /> </Column> <Column dataField="StateID" caption="State" > <Lookup dataSource={statesStore} displayExpr="Name" valueExpr="ID" /> <RequiredRule /> </Column> <Column dataField="BirthDate" dataType="date" > <RangeRule max={maxDate} message="Date can not be greater than 01/01/3000" /> </Column> </DataGrid> ); export default Grid;

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 DataGrid, { Column, Editing, Paging, RequiredRule, RangeRule, Lookup, } from 'devextreme-react/data-grid'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; const maxDate = new Date(3000, 0); const statesStore = AspNetData.createStore({ key: 'ID', loadUrl: 'https://js.devexpress.com/Demos/NetCore/api/DataGridStatesLookup', }); const Grid = (props) => ( <DataGrid dataSource={props.dataSource} height={600} showBorders={true} repaintChangesOnly={true} highlightChanges={true} > <Paging enabled={false} /> <Editing mode="cell" refreshMode="reshape" allowUpdating={true} allowDeleting={true} allowAdding={true} useIcons={true} /> <Column dataField="Prefix" caption="Title" width={50} > <RequiredRule /> </Column> <Column dataField="FirstName"> <RequiredRule /> </Column> <Column dataField="StateID" caption="State" > <Lookup dataSource={statesStore} displayExpr="Name" valueExpr="ID" /> <RequiredRule /> </Column> <Column dataField="BirthDate" dataType="date" > <RangeRule max={maxDate} message="Date can not be greater than 01/01/3000" /> </Column> </DataGrid> ); export default Grid;

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> <link rel="stylesheet" type="text/css" href="styles.css" /> <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>

.tables { display: flex; } .column:first-child { width: 50%; padding-right: 15px; } .column:last-child { width: 50%; padding-left: 15px; }

using DevExtreme.AspNet.Data; using DevExtreme.AspNet.Mvc; using DevExtreme.MVC.Demos.Hubs; using DevExtreme.MVC.Demos.Models.DataGrid; using DevExtreme.MVC.Demos.Models.SampleData; using Microsoft.AspNet.SignalR; using Newtonsoft.Json; using System; using System.Net; using System.Net.Http; using System.Net.Http.Formatting; using System.Web.Http; using DevExpress.Data.Utils; namespace DevExtreme.MVC.Demos.Controllers.ApiControllers { public class DataGridCollaborativeEditingController : ApiController { static readonly NonCryptographicRandom random = NonCryptographicRandom.System; IHubContext hubContext; public DataGridCollaborativeEditingController() { hubContext = GlobalHost.ConnectionManager.GetHubContext<DataGridCollaborativeEditingHub>(); } [HttpGet] public object Get(DataSourceLoadOptions loadOptions) { return DataSourceLoader.Load(SampleData.DataGridEmployees, loadOptions); } [HttpPost] public HttpResponseMessage Post(FormDataCollection form) { var values = form.Get("values"); var groupId = form.Get("groupId"); var newEmployee = new Employee(); JsonConvert.PopulateObject(values, newEmployee); newEmployee.ID = random.Next(int.MaxValue); Validate(newEmployee); if(!ModelState.IsValid) { return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage()); } // db.Employees.Add(newEmployee); // db.SaveChanges(); hubContext.Clients.Group(groupId).insert(newEmployee); return Request.CreateResponse(newEmployee); } [HttpPut] public HttpResponseMessage Put(FormDataCollection form) { var key = Convert.ToInt32(form.Get("key")); var values = form.Get("values"); var groupId = form.Get("groupId"); var employee = new Employee(); JsonConvert.PopulateObject(values, employee); employee.ID = key; Validate(employee); if(!ModelState.IsValid) { return Request.CreateErrorResponse(HttpStatusCode.BadRequest, ModelState.GetFullErrorMessage()); } // db.SaveChanges(); hubContext.Clients.Group(groupId).update(key, employee); return Request.CreateResponse(employee); } [HttpDelete] public void Delete(FormDataCollection form) { var key = Convert.ToInt32(form.Get("key")); var groupId = form.Get("groupId"); // var employee = db.Employees.First(a => a.ID == key); // db.Employees.Remove(employee); // db.SaveChanges(); hubContext.Clients.Group(groupId).remove(key); } } }

using Microsoft.AspNet.SignalR; using System.Threading.Tasks; namespace DevExtreme.MVC.Demos.Hubs { public class DataGridCollaborativeEditingHub : Hub { public override Task OnConnected() { var groupId = Context.QueryString["GroupId"]; Groups.Add(Context.ConnectionId, groupId); return base.OnConnected(); } } }

To implement this functionality:

Generate a session ID used to identify DataGrids that should be edited simultaneously (groupId in this demo).
Configure CustomStores. In this demo, we use the createStore method (part of the DevExtreme.AspNet.data extension). The onBeforeSend function is used to send the session ID from step 1 to the server.
Create store instances—one per DataGrid.
Create DataGrids and bind them to the store instances.
Update all the store instances when a push notification is received (see the updateStores function).

Changes made collaboratively are lost if you refresh the page because the SignalR service broadcasts changes without saving them.