DevExtreme v24.1 is now available.

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

Your search did not match any results.

Focused Row

The TreeList 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 TreeList automatically scrolls to the focused row. You can set the autoNavigateToFocusedRow property to false to deactivate this behavior. In the UI, users can click a row to focus it. The focused row is saved in the TreeList's state.

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

Backend API
import React, { useCallback, useState } from 'react'; import TreeList, { Column, Lookup, TreeListTypes } from 'devextreme-react/tree-list'; import { NumberBox, NumberBoxTypes } from 'devextreme-react/number-box'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; const url = 'https://js.devexpress.com/Demos/Mvc/api/TreeListTasks'; const dataSourceOptions = AspNetData.createStore({ key: 'Task_ID', loadUrl: `${url}/Tasks`, onBeforeSend(_, ajaxOptions) { ajaxOptions.xhrFields = { withCredentials: true }; }, }); const taskEmployees = AspNetData.createStore({ key: 'ID', loadMode: 'raw', loadUrl: `${url}/TaskEmployees`, }); const focusedRowKeyLabel = { 'aria-label': 'Focused Row Key' }; const App = () => { const [taskSubject, setTaskSubject] = useState(''); const [taskAssigned, setTaskAssigned] = useState(''); const [startDate, setStartDate] = useState(''); const [taskStatus, setTaskStatus] = useState(''); const [taskProgress, setTaskProgress] = useState(''); const [focusedRowKey, setFocusedRowKey] = useState(45); 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 onFocusedRowChanged = useCallback(async(e: TreeListTypes.FocusedRowChangedEvent) => { const rowData = e.row && e.row.data; if (rowData) { const progress = rowData.Task_Completion ? `${rowData.Task_Completion}%` : ''; const cellValue = e.component.cellValue(e.row.rowIndex, 'Assigned'); const item = await taskEmployees.byKey(cellValue); setTaskSubject(rowData.Task_Subject); setTaskAssigned(item.Name); setStartDate(new Date(rowData.Task_Start_Date).toLocaleDateString()); setTaskStatus(e.row.data.Task_Status); setTaskProgress(progress); setFocusedRowKey(e.component.option('focusedRowKey')); } }, []); return ( <div> <TreeList id="treeList" dataSource={dataSourceOptions} focusedRowEnabled={true} focusedRowKey={focusedRowKey} parentIdExpr="Task_Parent_ID" hasItemsExpr="Has_Items" wordWrapEnabled={true} showBorders={true} onFocusedRowChanged={onFocusedRowChanged}> <Column dataField="Task_ID" width={100} alignment="left" /> <Column dataField="Task_Assigned_Employee_ID" caption="Assigned" minWidth={120}> <Lookup dataSource={taskEmployees} valueExpr="ID" displayExpr="Name" /> </Column> <Column dataField="Task_Status" caption="Status" width={160} /> <Column dataField="Task_Start_Date" caption="Start Date" dataType="date" width={160} /> <Column dataField="Task_Due_Date" caption="Due Date" dataType="date" width={160} /> </TreeList> <div className="task-info"> <div className="info"> <div className="task-subject">{taskSubject}</div> <span className="task-assigned">{taskAssigned}</span> <span className="start-date">{startDate}</span> </div> <div className="progress"> <span className="task-status">{taskStatus}</span> <span className="task-progress">{taskProgress}</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Focused row key </span> <NumberBox id="taskId" min={1} max={182} step={0} value={focusedRowKey} inputAttr={focusedRowKeyLabel} onValueChanged={onTaskIdChanged}> </NumberBox> </div> </div> </div> ); }; export default App;
import React, { useCallback, useState } from 'react'; import TreeList, { Column, Lookup } from 'devextreme-react/tree-list'; import { NumberBox } from 'devextreme-react/number-box'; import * as AspNetData from 'devextreme-aspnet-data-nojquery'; const url = 'https://js.devexpress.com/Demos/Mvc/api/TreeListTasks'; const dataSourceOptions = AspNetData.createStore({ key: 'Task_ID', loadUrl: `${url}/Tasks`, onBeforeSend(_, ajaxOptions) { ajaxOptions.xhrFields = { withCredentials: true }; }, }); const taskEmployees = AspNetData.createStore({ key: 'ID', loadMode: 'raw', loadUrl: `${url}/TaskEmployees`, }); const focusedRowKeyLabel = { 'aria-label': 'Focused Row Key' }; const App = () => { const [taskSubject, setTaskSubject] = useState(''); const [taskAssigned, setTaskAssigned] = useState(''); const [startDate, setStartDate] = useState(''); const [taskStatus, setTaskStatus] = useState(''); const [taskProgress, setTaskProgress] = useState(''); const [focusedRowKey, setFocusedRowKey] = useState(45); const onTaskIdChanged = useCallback((e) => { if (e.event && e.value > 0) { setFocusedRowKey(e.value); } }, []); // eslint-disable-next-line @typescript-eslint/space-before-function-paren const onFocusedRowChanged = useCallback(async(e) => { const rowData = e.row && e.row.data; if (rowData) { const progress = rowData.Task_Completion ? `${rowData.Task_Completion}%` : ''; const cellValue = e.component.cellValue(e.row.rowIndex, 'Assigned'); const item = await taskEmployees.byKey(cellValue); setTaskSubject(rowData.Task_Subject); setTaskAssigned(item.Name); setStartDate(new Date(rowData.Task_Start_Date).toLocaleDateString()); setTaskStatus(e.row.data.Task_Status); setTaskProgress(progress); setFocusedRowKey(e.component.option('focusedRowKey')); } }, []); return ( <div> <TreeList id="treeList" dataSource={dataSourceOptions} focusedRowEnabled={true} focusedRowKey={focusedRowKey} parentIdExpr="Task_Parent_ID" hasItemsExpr="Has_Items" wordWrapEnabled={true} showBorders={true} onFocusedRowChanged={onFocusedRowChanged} > <Column dataField="Task_ID" width={100} alignment="left" /> <Column dataField="Task_Assigned_Employee_ID" caption="Assigned" minWidth={120} > <Lookup dataSource={taskEmployees} valueExpr="ID" displayExpr="Name" /> </Column> <Column dataField="Task_Status" caption="Status" width={160} /> <Column dataField="Task_Start_Date" caption="Start Date" dataType="date" width={160} /> <Column dataField="Task_Due_Date" caption="Due Date" dataType="date" width={160} /> </TreeList> <div className="task-info"> <div className="info"> <div className="task-subject">{taskSubject}</div> <span className="task-assigned">{taskAssigned}</span> <span className="start-date">{startDate}</span> </div> <div className="progress"> <span className="task-status">{taskStatus}</span> <span className="task-progress">{taskProgress}</span> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Focused row key </span> <NumberBox id="taskId" min={1} max={182} step={0} value={focusedRowKey} inputAttr={focusedRowKeyLabel} onValueChanged={onTaskIdChanged} ></NumberBox> </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.4/cjs', 'devextreme-react': 'npm:devextreme-react@24.1.4/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.10/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.4/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>
#treeList { max-height: 400px; } .task-info { font-family: "Segoe UI"; min-height: 100px; display: flex; flex-wrap: nowrap; border: 2px solid rgba(0, 0, 0, 0.1); padding: 16px; box-sizing: border-box; align-items: center; justify-content: space-between; } .info { display: flex; flex-direction: column; } .task-subject { line-height: 29px; font-size: 18px; font-weight: bold; } .progress { display: flex; flex-direction: column; white-space: pre; min-width: 105px; } .task-progress { 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; } .option > .dx-numberbox { width: 200px; display: inline-block; vertical-align: middle; } .option > span { margin-right: 10px; }

In this demo, the row with the 45 key is focused initially. You can specify the focusedRowKey property via the input field below the TreeList. The onFocusedRowChanged function is used to display additional information below the component when the focused row changes.