React Tree View - TreeView with Search Bar

To add a search bar to the TreeView and customize the search functionality, do the following:

Set the searchEnabled property to true.
Use the searchMode property to specify whether items should contain (default), start with, or match the search string. In this example, you can switch between search modes in the drop-down menu.
Configure the searchExpr property to specify custom search fields. The default search field is text.

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!

TS JS

Backend API

import React, { useCallback, useState } from 'react'; import { SearchMode } from 'devextreme-react/common'; import { TreeView } from 'devextreme-react/tree-view'; import { SelectBox, SelectBoxTypes } from 'devextreme-react/select-box'; import { products, searchModeLabel } from './data.ts'; const options: SearchMode[] = ['contains', 'startswith', 'equals']; const App = () => { const [value, setValue] = useState<SearchMode>('contains'); const valueChanged = useCallback((e: SelectBoxTypes.ValueChangedEvent) => { setValue(e.value); }, [setValue]); return ( <React.Fragment> <TreeView id="treeview" items={products} width={500} searchMode={value} searchEnabled={true} /> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Search mode</span> <SelectBox items={options} inputAttr={searchModeLabel} value={value} onValueChanged={valueChanged} /> </div> </div> </React.Fragment> ); }; export default App;

import React, { useCallback, useState } from 'react'; import { TreeView } from 'devextreme-react/tree-view'; import { SelectBox } from 'devextreme-react/select-box'; import { products, searchModeLabel } from './data.js'; const options = ['contains', 'startswith', 'equals']; const App = () => { const [value, setValue] = useState('contains'); const valueChanged = useCallback( (e) => { setValue(e.value); }, [setValue], ); return ( <React.Fragment> <TreeView id="treeview" items={products} width={500} searchMode={value} searchEnabled={true} /> <div className="options"> <div className="caption">Options</div> <div className="option"> <span>Search mode</span> <SelectBox items={options} inputAttr={searchModeLabel} value={value} onValueChanged={valueChanged} /> </div> </div> </React.Fragment> ); }; export default App;

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

export const products = [{ id: '1', text: 'Stores', expanded: true, items: [{ id: '1_1', text: 'Super Mart of the West', expanded: true, items: [{ id: '1_1_1', text: 'Video Players', items: [{ id: '1_1_1_1', text: 'HD Video Player', price: 220, }, { id: '1_1_1_2', text: 'SuperHD Video Player', price: 270, }], }, { id: '1_1_2', text: 'Televisions', items: [{ id: '1_1_2_1', text: 'SuperLCD 42', price: 1200, }, { id: '1_1_2_2', text: 'SuperLED 42', price: 1450, }, { id: '1_1_2_3', text: 'SuperLED 50', price: 1600, }, { id: '1_1_2_4', text: 'SuperLCD 55', price: 1350, }, { id: '1_1_2_5', text: 'SuperLCD 70', price: 4000, }], }, { id: '1_1_3', text: 'Monitors', items: [{ id: '1_1_3_1', text: '19"', items: [{ id: '1_1_3_1_1', text: 'DesktopLCD 19', price: 160, }], }, { id: '1_1_3_2', text: '21"', items: [{ id: '1_1_3_2_1', text: 'DesktopLCD 21', price: 170, }, { id: '1_1_3_2_2', text: 'DesktopLED 21', price: 175, }], }], }, { id: '1_1_4', text: 'Projectors', items: [{ id: '1_1_4_1', text: 'Projector Plus', price: 550, }, { id: '1_1_4_2', text: 'Projector PlusHD', price: 750, }], }], }, { id: '1_2', text: 'Braeburn', items: [{ id: '1_2_1', text: 'Video Players', items: [{ id: '1_2_1_1', text: 'HD Video Player', price: 240, }, { id: '1_2_1_2', text: 'SuperHD Video Player', price: 300, }], }, { id: '1_2_2', text: 'Televisions', items: [{ id: '1_2_2_1', text: 'SuperPlasma 50', price: 1800, }, { id: '1_2_2_2', text: 'SuperPlasma 65', price: 3500, }], }, { id: '1_2_3', text: 'Monitors', items: [{ id: '1_2_3_1', text: '19"', items: [{ id: '1_2_3_1_1', text: 'DesktopLCD 19', price: 170, }], }, { id: '1_2_3_2', text: '21"', items: [{ id: '1_2_3_2_1', text: 'DesktopLCD 21', price: 180, }, { id: '1_2_3_2_2', text: 'DesktopLED 21', price: 190, }], }], }], }, { id: '1_3', text: 'E-Mart', items: [{ id: '1_3_1', text: 'Video Players', items: [{ id: '1_3_1_1', text: 'HD Video Player', price: 220, }, { id: '1_3_1_2', text: 'SuperHD Video Player', price: 275, }], }, { id: '1_3_3', text: 'Monitors', items: [{ id: '1_3_3_1', text: '19"', items: [{ id: '1_3_3_1_1', text: 'DesktopLCD 19', price: 165, }], }, { id: '1_3_3_2', text: '21"', items: [{ id: '1_3_3_2_1', text: 'DesktopLCD 21', price: 175, }], }], }], }, { id: '1_4', text: 'Walters', items: [{ id: '1_4_1', text: 'Video Players', items: [{ id: '1_4_1_1', text: 'HD Video Player', price: 210, }, { id: '1_4_1_2', text: 'SuperHD Video Player', price: 250, }], }, { id: '1_4_2', text: 'Televisions', items: [{ id: '1_4_2_1', text: 'SuperLCD 42', price: 1100, }, { id: '1_4_2_2', text: 'SuperLED 42', price: 1400, }, { id: '1_4_2_3', text: 'SuperLED 50', price: 1500, }, { id: '1_4_2_4', text: 'SuperLCD 55', price: 1300, }, { id: '1_4_2_5', text: 'SuperLCD 70', price: 4000, }, { id: '1_4_2_6', text: 'SuperPlasma 50', price: 1700, }], }, { id: '1_4_3', text: 'Monitors', items: [{ id: '1_4_3_1', text: '19"', items: [{ id: '1_4_3_1_1', text: 'DesktopLCD 19', price: 160, }], }, { id: '1_4_3_2', text: '21"', items: [{ id: '1_4_3_2_1', text: 'DesktopLCD 21', price: 170, }, { id: '1_4_3_2_2', text: 'DesktopLED 21', price: 180, }], }], }, { id: '1_4_4', text: 'Projectors', items: [{ id: '1_4_4_1', text: 'Projector Plus', price: 550, }, { id: '1_4_4_2', text: 'Projector PlusHD', price: 750, }], }], }], }]; export const searchModeLabel = { 'aria-label': 'Search Mode' };

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

export const products = [ { id: '1', text: 'Stores', expanded: true, items: [ { id: '1_1', text: 'Super Mart of the West', expanded: true, items: [ { id: '1_1_1', text: 'Video Players', items: [ { id: '1_1_1_1', text: 'HD Video Player', price: 220, }, { id: '1_1_1_2', text: 'SuperHD Video Player', price: 270, }, ], }, { id: '1_1_2', text: 'Televisions', items: [ { id: '1_1_2_1', text: 'SuperLCD 42', price: 1200, }, { id: '1_1_2_2', text: 'SuperLED 42', price: 1450, }, { id: '1_1_2_3', text: 'SuperLED 50', price: 1600, }, { id: '1_1_2_4', text: 'SuperLCD 55', price: 1350, }, { id: '1_1_2_5', text: 'SuperLCD 70', price: 4000, }, ], }, { id: '1_1_3', text: 'Monitors', items: [ { id: '1_1_3_1', text: '19"', items: [ { id: '1_1_3_1_1', text: 'DesktopLCD 19', price: 160, }, ], }, { id: '1_1_3_2', text: '21"', items: [ { id: '1_1_3_2_1', text: 'DesktopLCD 21', price: 170, }, { id: '1_1_3_2_2', text: 'DesktopLED 21', price: 175, }, ], }, ], }, { id: '1_1_4', text: 'Projectors', items: [ { id: '1_1_4_1', text: 'Projector Plus', price: 550, }, { id: '1_1_4_2', text: 'Projector PlusHD', price: 750, }, ], }, ], }, { id: '1_2', text: 'Braeburn', items: [ { id: '1_2_1', text: 'Video Players', items: [ { id: '1_2_1_1', text: 'HD Video Player', price: 240, }, { id: '1_2_1_2', text: 'SuperHD Video Player', price: 300, }, ], }, { id: '1_2_2', text: 'Televisions', items: [ { id: '1_2_2_1', text: 'SuperPlasma 50', price: 1800, }, { id: '1_2_2_2', text: 'SuperPlasma 65', price: 3500, }, ], }, { id: '1_2_3', text: 'Monitors', items: [ { id: '1_2_3_1', text: '19"', items: [ { id: '1_2_3_1_1', text: 'DesktopLCD 19', price: 170, }, ], }, { id: '1_2_3_2', text: '21"', items: [ { id: '1_2_3_2_1', text: 'DesktopLCD 21', price: 180, }, { id: '1_2_3_2_2', text: 'DesktopLED 21', price: 190, }, ], }, ], }, ], }, { id: '1_3', text: 'E-Mart', items: [ { id: '1_3_1', text: 'Video Players', items: [ { id: '1_3_1_1', text: 'HD Video Player', price: 220, }, { id: '1_3_1_2', text: 'SuperHD Video Player', price: 275, }, ], }, { id: '1_3_3', text: 'Monitors', items: [ { id: '1_3_3_1', text: '19"', items: [ { id: '1_3_3_1_1', text: 'DesktopLCD 19', price: 165, }, ], }, { id: '1_3_3_2', text: '21"', items: [ { id: '1_3_3_2_1', text: 'DesktopLCD 21', price: 175, }, ], }, ], }, ], }, { id: '1_4', text: 'Walters', items: [ { id: '1_4_1', text: 'Video Players', items: [ { id: '1_4_1_1', text: 'HD Video Player', price: 210, }, { id: '1_4_1_2', text: 'SuperHD Video Player', price: 250, }, ], }, { id: '1_4_2', text: 'Televisions', items: [ { id: '1_4_2_1', text: 'SuperLCD 42', price: 1100, }, { id: '1_4_2_2', text: 'SuperLED 42', price: 1400, }, { id: '1_4_2_3', text: 'SuperLED 50', price: 1500, }, { id: '1_4_2_4', text: 'SuperLCD 55', price: 1300, }, { id: '1_4_2_5', text: 'SuperLCD 70', price: 4000, }, { id: '1_4_2_6', text: 'SuperPlasma 50', price: 1700, }, ], }, { id: '1_4_3', text: 'Monitors', items: [ { id: '1_4_3_1', text: '19"', items: [ { id: '1_4_3_1_1', text: 'DesktopLCD 19', price: 160, }, ], }, { id: '1_4_3_2', text: '21"', items: [ { id: '1_4_3_2_1', text: 'DesktopLCD 21', price: 170, }, { id: '1_4_3_2_2', text: 'DesktopLED 21', price: 180, }, ], }, ], }, { id: '1_4_4', text: 'Projectors', items: [ { id: '1_4_4_1', text: 'Projector Plus', price: 550, }, { id: '1_4_4_2', text: 'Projector PlusHD', price: 750, }, ], }, ], }, ], }, ]; export const searchModeLabel = { 'aria-label': 'Search 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/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>

#treeview { height: 400px; } .options { padding: 20px; position: absolute; bottom: 0; right: 0; width: 260px; top: 0; background-color: #f5f5f5; } .caption { font-size: 18px; font-weight: 500; } .option { margin-top: 10px; } .option > .dx-selectbox { display: inline-block; vertical-align: middle; max-width: 350px; width: 100%; margin-top: 5px; }

The TreeView uses the TextBox component as a search bar. To customize it, specify TextBox properties in the searchEditorOptions object.

We do not recommend that you enable search if the TreeView uses virtual mode or custom logic to load data on demand. In these cases, the TreeView may not have the full dataset, and the search results include only loaded nodes.