DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

React Data Grid - Focused Row

The DataGrid component can highlight the focused row. To enable this feature, set the focusedRowEnabled property to true.

To focus a row programmatically, specify the focusedRowKey property. The DataGrid automatically scrolls to the focused row if the autoNavigateToFocusedRow property is enabled. In the UI, users can click a row to focus it. The focused row is saved in the DataGrid's state.

You can use the onFocusedRowChanging or onFocusedRowChanged property to specify a custom function that is executed before or after a row is focused.

Backend API
import React, { useCallback, useState } from 'react'; import { DataGrid, Column, Paging, DataGridTypes, Pager, } from 'devextreme-react/data-grid'; import { NumberBox, NumberBoxTypes } from 'devextreme-react/number-box'; import { CheckBox, CheckBoxTypes } from 'devextreme-react/check-box'; import 'devextreme/data/odata/store'; const focusedRowKeyLabel = { 'aria-label': 'Focused Row Key' }; const dataSourceOptions = { store: { type: 'odata' as const, version: 2, key: 'Task_ID', url: 'https://js.devexpress.com/Demos/DevAV/odata/Tasks', }, expand: 'ResponsibleEmployee', select: [ 'Task_ID', 'Task_Subject', 'Task_Start_Date', 'Task_Status', 'Task_Description', 'Task_Completion', 'ResponsibleEmployee/Employee_Full_Name', ], }; const App = () => { const [taskSubject, setTaskSubject] = useState(''); const [taskDetails, setTaskDetails] = useState(''); const [taskStatus, setTaskStatus] = useState(''); const [taskProgress, setTaskProgress] = useState(''); const [focusedRowKey, setFocusedRowKey] = useState(117); const [autoNavigateToFocusedRow, setAutoNavigateToFocusedRow] = useState(true); const onTaskIdChanged = useCallback((e: NumberBoxTypes.ValueChangedEvent) => { if (e.event && e.value > 0) { setFocusedRowKey(e.value); } }, []); // eslint-disable-next-line @typescript-eslint/space-before-function-paren const onFocusedRowChanging = useCallback(async(e: DataGridTypes.FocusedRowChangingEvent) => { const rowsCount = e.component.getVisibleRows().length; const pageCount = e.component.pageCount(); const pageIndex = e.component.pageIndex(); const event = e?.event as any; const key = event.key; if (key && e.prevRowIndex === e.newRowIndex) { if (e.newRowIndex === rowsCount - 1 && pageIndex < pageCount - 1) { await e.component.pageIndex(pageIndex + 1); e.component.option('focusedRowIndex', 0); } else if (e.newRowIndex === 0 && pageIndex > 0) { await e.component.pageIndex(pageIndex - 1); e.component.option('focusedRowIndex', rowsCount - 1); } } }, []); const onFocusedRowChanged = useCallback((e: DataGridTypes.FocusedRowChangedEvent) => { const data = e.row.data; const progress = data.Task_Completion ? `${data.Task_Completion}%` : ''; setTaskSubject(data.Task_Subject); setTaskDetails(data.Task_Description); setTaskStatus(data.Task_Status); setTaskProgress(progress); setFocusedRowKey(e.component.option('focusedRowKey')); }, []); const onAutoNavigateToFocusedRowChanged = useCallback((e: CheckBoxTypes.ValueChangedEvent) => { setAutoNavigateToFocusedRow(e.value); }, []); return ( <div> <DataGrid id="gridContainer" dataSource={dataSourceOptions} focusedRowEnabled={true} focusedRowKey={focusedRowKey} autoNavigateToFocusedRow={autoNavigateToFocusedRow} onFocusedRowChanging={onFocusedRowChanging} onFocusedRowChanged={onFocusedRowChanged} showBorders={true} > <Paging defaultPageSize={10} /> <Pager visible={true} /> <Column dataField="Task_ID" width={80} /> <Column caption="Start Date" dataField="Task_Start_Date" dataType="date" /> <Column caption="Assigned To" dataField="ResponsibleEmployee.Employee_Full_Name" dataType="date" allowSorting={false} /> <Column caption="Subject" dataField="Task_Subject" width={350} /> <Column caption="Status" dataField="Task_Status" /> </DataGrid> <div className="task-info"> <div className="info"> <div id="taskSubject">{taskSubject}</div> <p id="taskDetails" dangerouslySetInnerHTML={{ __html: taskDetails }}></p> </div> <div className="progress"> <span id="taskStatus">{taskStatus}</span> <span id="taskProgress">{taskProgress}</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="options-container"> <div className="option"> <span>Focused Row Key </span> <NumberBox id="taskId" min={1} max={183} step={0} value={focusedRowKey} inputAttr={focusedRowKeyLabel} onValueChanged={onTaskIdChanged}> </NumberBox> </div> <div className="option"> <CheckBox text="Auto Navigate To Focused Row" value={autoNavigateToFocusedRow} onValueChanged={onAutoNavigateToFocusedRowChanged}> </CheckBox> </div> </div> </div> </div> ); }; export default App;
import React, { useCallback, useState } from 'react'; import { DataGrid, Column, Paging, Pager, } from 'devextreme-react/data-grid'; import { NumberBox } from 'devextreme-react/number-box'; import { CheckBox } from 'devextreme-react/check-box'; import 'devextreme/data/odata/store'; const focusedRowKeyLabel = { 'aria-label': 'Focused Row Key' }; const dataSourceOptions = { store: { type: 'odata', version: 2, key: 'Task_ID', url: 'https://js.devexpress.com/Demos/DevAV/odata/Tasks', }, expand: 'ResponsibleEmployee', select: [ 'Task_ID', 'Task_Subject', 'Task_Start_Date', 'Task_Status', 'Task_Description', 'Task_Completion', 'ResponsibleEmployee/Employee_Full_Name', ], }; const App = () => { const [taskSubject, setTaskSubject] = useState(''); const [taskDetails, setTaskDetails] = useState(''); const [taskStatus, setTaskStatus] = useState(''); const [taskProgress, setTaskProgress] = useState(''); const [focusedRowKey, setFocusedRowKey] = useState(117); const [autoNavigateToFocusedRow, setAutoNavigateToFocusedRow] = useState(true); const onTaskIdChanged = useCallback((e) => { if (e.event && e.value > 0) { setFocusedRowKey(e.value); } }, []); // eslint-disable-next-line @typescript-eslint/space-before-function-paren const onFocusedRowChanging = useCallback(async(e) => { const rowsCount = e.component.getVisibleRows().length; const pageCount = e.component.pageCount(); const pageIndex = e.component.pageIndex(); const event = e?.event; const key = event.key; if (key && e.prevRowIndex === e.newRowIndex) { if (e.newRowIndex === rowsCount - 1 && pageIndex < pageCount - 1) { await e.component.pageIndex(pageIndex + 1); e.component.option('focusedRowIndex', 0); } else if (e.newRowIndex === 0 && pageIndex > 0) { await e.component.pageIndex(pageIndex - 1); e.component.option('focusedRowIndex', rowsCount - 1); } } }, []); const onFocusedRowChanged = useCallback((e) => { const data = e.row.data; const progress = data.Task_Completion ? `${data.Task_Completion}%` : ''; setTaskSubject(data.Task_Subject); setTaskDetails(data.Task_Description); setTaskStatus(data.Task_Status); setTaskProgress(progress); setFocusedRowKey(e.component.option('focusedRowKey')); }, []); const onAutoNavigateToFocusedRowChanged = useCallback((e) => { setAutoNavigateToFocusedRow(e.value); }, []); return ( <div> <DataGrid id="gridContainer" dataSource={dataSourceOptions} focusedRowEnabled={true} focusedRowKey={focusedRowKey} autoNavigateToFocusedRow={autoNavigateToFocusedRow} onFocusedRowChanging={onFocusedRowChanging} onFocusedRowChanged={onFocusedRowChanged} showBorders={true} > <Paging defaultPageSize={10} /> <Pager visible={true} /> <Column dataField="Task_ID" width={80} /> <Column caption="Start Date" dataField="Task_Start_Date" dataType="date" /> <Column caption="Assigned To" dataField="ResponsibleEmployee.Employee_Full_Name" dataType="date" allowSorting={false} /> <Column caption="Subject" dataField="Task_Subject" width={350} /> <Column caption="Status" dataField="Task_Status" /> </DataGrid> <div className="task-info"> <div className="info"> <div id="taskSubject">{taskSubject}</div> <p id="taskDetails" dangerouslySetInnerHTML={{ __html: taskDetails }} ></p> </div> <div className="progress"> <span id="taskStatus">{taskStatus}</span> <span id="taskProgress">{taskProgress}</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="options-container"> <div className="option"> <span>Focused Row Key </span> <NumberBox id="taskId" min={1} max={183} step={0} value={focusedRowKey} inputAttr={focusedRowKeyLabel} onValueChanged={onTaskIdChanged} ></NumberBox> </div> <div className="option"> <CheckBox text="Auto Navigate To Focused Row" value={autoNavigateToFocusedRow} onValueChanged={onAutoNavigateToFocusedRowChanged} ></CheckBox> </div> </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'), );
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, 'devextreme-aspnet-data-nojquery': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'devextreme-aspnet-data-nojquery': 'npm:devextreme-aspnet-data-nojquery@3.0.0/index.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@24.1.7/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.7/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.13/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: 'json', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
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/24.1.7/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.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.task-info { font-family: "Segoe UI"; min-height: 200px; display: flex; flex-wrap: nowrap; border: 2px solid rgba(0, 0, 0, 0.1); padding: 16px; box-sizing: border-box; align-items: baseline; justify-content: space-between; } #taskSubject { line-height: 29px; font-size: 18px; font-weight: bold; } #taskDetails { line-height: 22px; font-size: 14px; margin-top: 0; margin-bottom: 0; } .progress { display: flex; flex-direction: column; white-space: pre; min-width: 105px; } .info { margin-right: 40px; } #taskProgress { line-height: 42px; font-size: 40px; font-weight: bold; } .options { margin-top: 20px; padding: 20px; background-color: rgba(191, 191, 191, 0.15); position: relative; } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; margin-right: 40px; display: inline-block; } .option:last-child { margin-right: 0; } .option > .dx-numberbox { width: 200px; display: inline-block; vertical-align: middle; } .option > span { margin-right: 10px; } .options-container { display: flex; align-items: center; }

In this demo, the row with the 117 key is focused initially. You can specify the focusedRowKey and autoNavigateToFocusedRow properties via the input field and the checkbox below the DataGrid.