State Persistence

The DataGrid can persist its state. If a user sorts and filters data, groups, reorders and resizes columns, or makes other changes, the component saves these modifications and restores them when a user reloads the page. Refer to the stateStoring article for a full list of modifications that can be saved.

To enable state persistence, set stateStoring.enabled to true and specify the storageKey and type properties. Depending on the type, the state can be saved to a localStorage or sessionStorage. With localStorage, the state persists across browser sessions; with sessionStorage, it is reset after the current session. This demo uses localStorage.

Alternatively, you can implement the customSave and customLoad functions to save and load the state according to custom logic. In this case, set the type property to "custom".

Prev Demo

Next Demo

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

import React from 'react'; import DataGrid, { Selection, FilterRow, GroupPanel, StateStoring, Pager, Column, } from 'devextreme-react/data-grid'; import service from './data.js'; const allowedPageSizes = [5, 10, 20]; class App extends React.Component { constructor(props) { super(props); this.orders = service.getOrders(); this.dataGrid = React.createRef(); this.onStateResetClick = this.onStateResetClick.bind(this); } onRefreshClick() { window.location.reload(); } onStateResetClick() { this.dataGrid.current.instance.state(null); } render() { return ( <React.Fragment> <div id="descContainer">Sort and filter data, group, reorder and resize columns, change page numbers and page size. Once you are done, <a onClick={this.onRefreshClick}>refresh</a> the web page to see that the grid’s state is automatically persisted to continue working from where you stopped or you can <a onClick={this.onStateResetClick}>reset</a> the grid to its initial state.</div> <DataGrid id="gridContainer" ref={this.dataGrid} dataSource={this.orders} keyExpr="ID" allowColumnResizing={true} allowColumnReordering={true} width="100%" showBorders={true}> <Selection mode="single" /> <FilterRow visible={true} /> <GroupPanel visible={true} /> <StateStoring enabled={true} type="localStorage" storageKey="storage" /> <Pager showPageSizeSelector={true} allowedPageSizes={allowedPageSizes} /> <Column dataField="OrderNumber" caption="Invoice Number" width={130} /> <Column dataField="OrderDate" sortOrder="desc" dataType="date" /> <Column dataField="SaleAmount" alignment="right" format="currency" /> <Column dataField="Employee" /> <Column dataField="CustomerStoreCity" caption="City" /> <Column dataField="CustomerStoreState" caption="State" groupIndex={0} /> </DataGrid> </React.Fragment> ); } } export default App;

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

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

#gridContainer { height: 440px; margin-top: 30px; } #descContainer a { color: #f05b41; text-decoration: underline; cursor: pointer; } #descContainer a:hover { text-decoration: none; }