DevExtreme v26.1 is now available.

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

Your search did not match any results.

React Tree View - Selection and Customization

The DevExtreme TreeView allows users to select individual tree nodes (on click or using checkboxes). In this demo, selected items appear as a flat (non-hierarchical) List.

Backend API
import React, { useCallback, useRef, useState } from 'react'; import TreeView from 'devextreme-react/tree-view'; import type { TreeViewTypes, TreeViewRef } from 'devextreme-react/tree-view'; import List from 'devextreme-react/list'; import SelectBox, { type SelectBoxTypes } from 'devextreme-react/select-box'; import CheckBox, { type CheckBoxTypes } from 'devextreme-react/check-box'; import { employees, checkboxVisibilityLabel, selectionModeLabel, disabledNodeSelectionModeLabel, } from './data.ts'; import type { Employee } from './types'; const checkboxVisibilityOptions: TreeViewTypes.TreeViewCheckBoxMode[] = ['normal', 'selectAll', 'none']; const selectionModes: TreeViewTypes.SingleOrMultiple[] = ['multiple', 'single']; const disabledNodeSelectionModes: TreeViewTypes.DisabledNodeSelectionMode[] = ['never', 'recursiveAndAll']; const renderTreeViewItem = (item: Employee): string => `${item.fullName} (${item.position})`; const renderListItem = (item: Employee): string => `${item.prefix} ${item.fullName} (${item.position})`; const App = () => { const treeViewRef = useRef<TreeViewRef<Employee>>(null); const [selectedEmployees, setSelectedEmployees] = useState<(Employee | undefined)[]>([]); const [recursiveSelection, setRecursiveSelection] = useState<boolean>(true); const [selectOnClick, setSelectOnClick] = useState<boolean>(false); const [checkboxVisibility, setCheckboxVisibility] = useState<TreeViewTypes.TreeViewCheckBoxMode>(checkboxVisibilityOptions[0]); const [selectionMode, setSelectionMode] = useState<TreeViewTypes.SingleOrMultiple>(selectionModes[0]); const [disabledNodeSelectionMode, setDisabledNodeSelectionMode] = useState<TreeViewTypes.DisabledNodeSelectionMode>(disabledNodeSelectionModes[0]); const [isSelectionModeDisabled, setIsSelectionModeDisabled] = useState<boolean>(false); const [isRecursiveDisabled, setIsRecursiveDisabled] = useState<boolean>(false); const syncSelection = useCallback((treeView: ReturnType<TreeViewRef<Employee>['instance']>): void => { const syncSelectedEmployees = treeView.getSelectedNodes() .map((node: TreeViewTypes.Node<Employee>): Employee | undefined => node.itemData); setSelectedEmployees(syncSelectedEmployees); }, []); const treeViewSelectionChanged = useCallback((e: TreeViewTypes.SelectionChangedEvent<Employee>): void => { syncSelection(e.component); }, [syncSelection]); const treeViewContentReady = useCallback((e: TreeViewTypes.ContentReadyEvent<Employee>): void => { syncSelection(e.component); }, [syncSelection]); const checkboxVisibilityValueChanged = useCallback((e: SelectBoxTypes.ValueChangedEvent): void => { const value = e.value; setCheckboxVisibility(value); if (value === 'selectAll') { setSelectionMode('multiple'); setIsRecursiveDisabled(false); } setIsSelectionModeDisabled(value === 'selectAll'); }, []); const selectionModeValueChanged = useCallback((e: SelectBoxTypes.ValueChangedEvent): void => { const value = e.value; setSelectionMode(value); if (value === 'single') { setRecursiveSelection(false); treeViewRef.current?.instance().unselectAll(); } setIsRecursiveDisabled(value === 'single'); }, []); const disabledNodeSelectionModeValueChanged = useCallback((e: SelectBoxTypes.ValueChangedEvent): void => { setDisabledNodeSelectionMode(e.value); }, []); const recursiveSelectionValueChanged = useCallback((e: CheckBoxTypes.ValueChangedEvent): void => { setRecursiveSelection(e.value); }, []); const selectOnClickValueChanged = useCallback((e: CheckBoxTypes.ValueChangedEvent): void => { setSelectOnClick(e.value); }, []); return ( <div> <div className="form"> <h4>Employees</h4> <TreeView id="treeview" ref={treeViewRef} width={340} height={320} items={employees} selectNodesRecursive={recursiveSelection} selectByClick={selectOnClick} showCheckBoxesMode={checkboxVisibility} selectionMode={selectionMode} disabledNodeSelectionMode={disabledNodeSelectionMode} onSelectionChanged={treeViewSelectionChanged} onContentReady={treeViewContentReady} itemRender={renderTreeViewItem} /> {' '} <div className="selected-container">Selected employees <List id="selected-employees" width={400} height={200} showScrollbar="always" items={selectedEmployees} itemRender={renderListItem} /> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="options-container"> <div className="options-section"> <div className="option"> <span>Checkbox Visibility:</span> <div className="editor-container"> <SelectBox items={checkboxVisibilityOptions} value={checkboxVisibility} inputAttr={checkboxVisibilityLabel} onValueChanged={checkboxVisibilityValueChanged} /> </div> </div> <div className="option"> <span>Selection Mode:</span> <div className="editor-container"> <SelectBox items={selectionModes} value={selectionMode} inputAttr={selectionModeLabel} disabled={isSelectionModeDisabled} onValueChanged={selectionModeValueChanged} /> </div> </div> <div className="option"> <span>Disabled Node Selection Mode:</span> <div className="editor-container"> <SelectBox items={disabledNodeSelectionModes} value={disabledNodeSelectionMode} inputAttr={disabledNodeSelectionModeLabel} onValueChanged={disabledNodeSelectionModeValueChanged} /> </div> </div> </div> <div className="options-section"> <div className="option"> <div className="caption-placeholder">&nbsp;</div> <div className="editor-container"> <CheckBox text="Recursive Selection" value={recursiveSelection} disabled={isRecursiveDisabled} onValueChanged={recursiveSelectionValueChanged} /> </div> </div> <div className="option"> <div className="caption-placeholder">&nbsp;</div> <div className="editor-container"> <CheckBox text="Select on Click" value={selectOnClick} onValueChanged={selectOnClickValueChanged} /> </div> </div> </div> </div> </div> </div> ); }; export default App;
import React, { useCallback, useRef, useState } from 'react'; import TreeView from 'devextreme-react/tree-view'; import List from 'devextreme-react/list'; import SelectBox from 'devextreme-react/select-box'; import CheckBox from 'devextreme-react/check-box'; import { employees, checkboxVisibilityLabel, selectionModeLabel, disabledNodeSelectionModeLabel, } from './data.js'; const checkboxVisibilityOptions = ['normal', 'selectAll', 'none']; const selectionModes = ['multiple', 'single']; const disabledNodeSelectionModes = ['never', 'recursiveAndAll']; const renderTreeViewItem = (item) => `${item.fullName} (${item.position})`; const renderListItem = (item) => `${item.prefix} ${item.fullName} (${item.position})`; const App = () => { const treeViewRef = useRef(null); const [selectedEmployees, setSelectedEmployees] = useState([]); const [recursiveSelection, setRecursiveSelection] = useState(true); const [selectOnClick, setSelectOnClick] = useState(false); const [checkboxVisibility, setCheckboxVisibility] = useState(checkboxVisibilityOptions[0]); const [selectionMode, setSelectionMode] = useState(selectionModes[0]); const [disabledNodeSelectionMode, setDisabledNodeSelectionMode] = useState( disabledNodeSelectionModes[0], ); const [isSelectionModeDisabled, setIsSelectionModeDisabled] = useState(false); const [isRecursiveDisabled, setIsRecursiveDisabled] = useState(false); const syncSelection = useCallback((treeView) => { const syncSelectedEmployees = treeView.getSelectedNodes().map((node) => node.itemData); setSelectedEmployees(syncSelectedEmployees); }, []); const treeViewSelectionChanged = useCallback( (e) => { syncSelection(e.component); }, [syncSelection], ); const treeViewContentReady = useCallback( (e) => { syncSelection(e.component); }, [syncSelection], ); const checkboxVisibilityValueChanged = useCallback((e) => { const value = e.value; setCheckboxVisibility(value); if (value === 'selectAll') { setSelectionMode('multiple'); setIsRecursiveDisabled(false); } setIsSelectionModeDisabled(value === 'selectAll'); }, []); const selectionModeValueChanged = useCallback((e) => { const value = e.value; setSelectionMode(value); if (value === 'single') { setRecursiveSelection(false); treeViewRef.current?.instance().unselectAll(); } setIsRecursiveDisabled(value === 'single'); }, []); const disabledNodeSelectionModeValueChanged = useCallback((e) => { setDisabledNodeSelectionMode(e.value); }, []); const recursiveSelectionValueChanged = useCallback((e) => { setRecursiveSelection(e.value); }, []); const selectOnClickValueChanged = useCallback((e) => { setSelectOnClick(e.value); }, []); return ( <div> <div className="form"> <h4>Employees</h4> <TreeView id="treeview" ref={treeViewRef} width={340} height={320} items={employees} selectNodesRecursive={recursiveSelection} selectByClick={selectOnClick} showCheckBoxesMode={checkboxVisibility} selectionMode={selectionMode} disabledNodeSelectionMode={disabledNodeSelectionMode} onSelectionChanged={treeViewSelectionChanged} onContentReady={treeViewContentReady} itemRender={renderTreeViewItem} />{' '} <div className="selected-container"> Selected employees <List id="selected-employees" width={400} height={200} showScrollbar="always" items={selectedEmployees} itemRender={renderListItem} /> </div> </div> <div className="options"> <div className="caption">Options</div> <div className="options-container"> <div className="options-section"> <div className="option"> <span>Checkbox Visibility:</span> <div className="editor-container"> <SelectBox items={checkboxVisibilityOptions} value={checkboxVisibility} inputAttr={checkboxVisibilityLabel} onValueChanged={checkboxVisibilityValueChanged} /> </div> </div> <div className="option"> <span>Selection Mode:</span> <div className="editor-container"> <SelectBox items={selectionModes} value={selectionMode} inputAttr={selectionModeLabel} disabled={isSelectionModeDisabled} onValueChanged={selectionModeValueChanged} /> </div> </div> <div className="option"> <span>Disabled Node Selection Mode:</span> <div className="editor-container"> <SelectBox items={disabledNodeSelectionModes} value={disabledNodeSelectionMode} inputAttr={disabledNodeSelectionModeLabel} onValueChanged={disabledNodeSelectionModeValueChanged} /> </div> </div> </div> <div className="options-section"> <div className="option"> <div className="caption-placeholder">&nbsp;</div> <div className="editor-container"> <CheckBox text="Recursive Selection" value={recursiveSelection} disabled={isRecursiveDisabled} onValueChanged={recursiveSelectionValueChanged} /> </div> </div> <div className="option"> <div className="caption-placeholder">&nbsp;</div> <div className="editor-container"> <CheckBox text="Select on Click" value={selectOnClick} onValueChanged={selectOnClickValueChanged} /> </div> </div> </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'), );
import type { Employee } from './types.ts'; export const employees: Employee[] = [{ id: 1, fullName: 'John Heart', prefix: 'Dr.', position: 'CEO', expanded: true, items: [{ id: 2, fullName: 'Samantha Bright', prefix: 'Dr.', position: 'COO', expanded: true, disabled: true, items: [{ id: 3, fullName: 'Kevin Carter', prefix: 'Mr.', position: 'Shipping Manager', }, { id: 14, fullName: 'Victor Norris', prefix: 'Mr.', selected: true, position: 'Shipping Assistant', }], }, { id: 4, fullName: 'Brett Wade', prefix: 'Mr.', position: 'IT Manager', expanded: true, items: [{ id: 5, fullName: 'Amelia Harper', prefix: 'Mrs.', position: 'Network Admin', }, { id: 6, fullName: 'Wally Hobbs', prefix: 'Mr.', position: 'Programmer', }, { id: 7, fullName: 'Brad Jameson', prefix: 'Mr.', position: 'Programmer', }, { id: 8, fullName: 'Violet Bailey', prefix: 'Ms.', position: 'Jr Graphic Designer', }], }, { id: 9, fullName: 'Barb Banks', prefix: 'Mrs.', position: 'Support Manager', expanded: true, items: [{ id: 10, fullName: 'Kelly Rodriguez', prefix: 'Ms.', position: 'Support Assistant', }, { id: 11, fullName: 'James Anderson', prefix: 'Mr.', position: 'Support Assistant', }], }], }]; export const selectionModeLabel = { 'aria-label': 'Selection Mode' }; export const checkboxVisibilityLabel = { 'aria-label': 'Checkbox Visibility' }; export const disabledNodeSelectionModeLabel = { 'aria-label': 'Disabled Node Selection Mode' };
export type Employee = { id: number; fullName: string; prefix: string; position: string; expanded?: boolean; selected?: boolean; disabled?: boolean; items?: Employee[]; };
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
export const employees = [ { id: 1, fullName: 'John Heart', prefix: 'Dr.', position: 'CEO', expanded: true, items: [ { id: 2, fullName: 'Samantha Bright', prefix: 'Dr.', position: 'COO', expanded: true, disabled: true, items: [ { id: 3, fullName: 'Kevin Carter', prefix: 'Mr.', position: 'Shipping Manager', }, { id: 14, fullName: 'Victor Norris', prefix: 'Mr.', selected: true, position: 'Shipping Assistant', }, ], }, { id: 4, fullName: 'Brett Wade', prefix: 'Mr.', position: 'IT Manager', expanded: true, items: [ { id: 5, fullName: 'Amelia Harper', prefix: 'Mrs.', position: 'Network Admin', }, { id: 6, fullName: 'Wally Hobbs', prefix: 'Mr.', position: 'Programmer', }, { id: 7, fullName: 'Brad Jameson', prefix: 'Mr.', position: 'Programmer', }, { id: 8, fullName: 'Violet Bailey', prefix: 'Ms.', position: 'Jr Graphic Designer', }, ], }, { id: 9, fullName: 'Barb Banks', prefix: 'Mrs.', position: 'Support Manager', expanded: true, items: [ { id: 10, fullName: 'Kelly Rodriguez', prefix: 'Ms.', position: 'Support Assistant', }, { id: 11, fullName: 'James Anderson', prefix: 'Mr.', position: 'Support Assistant', }, ], }, ], }, ]; export const selectionModeLabel = { 'aria-label': 'Selection Mode' }; export const checkboxVisibilityLabel = { 'aria-label': 'Checkbox Visibility' }; export const disabledNodeSelectionModeLabel = { 'aria-label': 'Disabled Node Selection Mode' };
<!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/26.1.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="./bundle.css" /> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> <script src="bundles/vendor/react.vendor.js"></script> <script src="./bundle.js"></script> </body> </html>
.form > h4 { margin-bottom: 20px; } .form > div, #treeview { display: inline-block; vertical-align: top; } #selected-employees { margin-top: 20px; } .selected-container .dx-list-item-content { padding-left: 0; } .selected-container { padding: 20px; margin-left: 20px; background-color: rgba(191, 191, 191, 0.15); font-size: 115%; font-weight: bold; } .options { padding: 20px; background-color: rgba(191, 191, 191, 0.15); margin-top: 20px; box-sizing: border-box; } .caption { font-size: 18px; font-weight: 500; } .option { width: 30%; margin-top: 10px; margin-right: 9px; box-sizing: border-box; display: flex; flex-direction: column; justify-content: center; } .options-container { display: flex; flex-direction: column; } .options-section { display: flex; } .editor-container { height: 100%; display: flex; align-items: center; } .editor-container > * { width: 100%; } .option:last-of-type { margin-right: 0; }

Use the options pane below the TreeView to modify selection behavior as follows:

The TreeView allows you to update node selection states programmatically. You can select/deselect items by node keys, data objects, or DOM elements. To initially select nodes, configure selection fields within item objects (default: selected).

You can use data fields to customize items as your requirements dictate. This demo implements itemRender to merge text from multiple fields: you do not need to specify the text field for your TreeView data source.