--- title: "Tree View" slug: tree-view category: component type: examples version: 20.0.0 tokens: 3246 source: https://ovh.github.io/design-system/v20.0.0/llms/react-components-tree-view--examples.txt --- # Tree View ## Default ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( )) } ); } ``` ## Multiple ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( )) } ) } ``` ## Disabled ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( )) } ); } ``` ## Custom Render ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( { ({ item, isBranch, isExpanded }) => ( { isBranch ? (isExpanded ? : ) : } { item.name } ) } )) } ); } ``` ## Default Expanded Value ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( )) } ); } ``` ## Controlled ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; const [selectedId, setSelectedId] = useState('package.json'); return ( <> setSelectedId(d.value[0])} value={ selectedId ? [selectedId] : undefined }> { items.map((item) => ( )) } Selected: { selectedId ?? 'None' } > ); } ``` ## Controlled Multiple ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; const [selectedIds, setSelectedIds] = useState(['package.json', 'index.ts']); return ( <> setSelectedIds(Array.isArray(d.value) ? d.value : [d.value].filter(Boolean) as string[])} value={ selectedIds }> { items.map((item) => ( )) } Selected: { selectedIds.length ? selectedIds.join(', ') : 'None' } > ); } ``` ## Disabled Items ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts', disabled: true }, { id: 'components', name: 'components', disabled: true, children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx', disabled: true }, ], }, ], }, { id: 'package.json', name: 'package.json', disabled: true }, { id: 'readme.md', name: 'README.md' }, ]; return ( { items.map((item) => ( )) } ); } ``` ## In Form Field ```tsx { const items = [ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [ { id: 'Button.tsx', name: 'Button.tsx' }, { id: 'Card.tsx', name: 'Card.tsx' }, ], }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]; return ( Choose a file { items.map((item) => ( )) } ); } ``` ## Dynamic Children ```tsx { type Item = { id: string, name: string, children?: Item[] }; const [items, setItems] = useState([ { id: 'src', name: 'src', children: [ { id: 'app.tsx', name: 'app.tsx' }, { id: 'index.ts', name: 'index.ts' }, { id: 'components', name: 'components', children: [] }, ], }, { id: 'package.json', name: 'package.json' }, { id: 'readme.md', name: 'README.md' }, ]); const counter = useRef(1); function addChildTo(collection: Item[], parentId: string, newNode: Item): Item[] { return collection.map((node) => { if (node.id === parentId) { const nextChildren = Array.isArray(node.children) ? [...node.children, newNode] : [newNode]; return { ...node, children: nextChildren }; } if (node.children?.length) { return { ...node, children: addChildTo(node.children, parentId, newNode) }; } return node; }); } function removeNodeFrom(collection: Item[], nodeId: string): Item[] { return collection .filter((node) => node.id !== nodeId) .map((node) => node.children?.length ? { ...node, children: removeNodeFrom(node.children, nodeId) } : node); } function handleAddChild(parentId: string): void { const id = `new-file-${counter.current++}.txt`; const newNode = { id, name: id }; setItems((prev) => addChildTo(prev, parentId, newNode)); } function handleDelete(nodeId: string): void { setItems((prev) => removeNodeFrom(prev, nodeId)); } function handleAddRootFile(): void { const id = `new-file-${counter.current++}.txt`; const newNode = { id, name: id }; setItems((prev) => [...prev, newNode]); } return ( Add file at root level { items.map((item) => ( { ({ item, isBranch }) => ( { isBranch ? : } { item.name } { isBranch ? ( { e.stopPropagation(); handleAddChild(item.id); }} size={ BUTTON_SIZE.xs } onKeyDown={(e) => { e.stopPropagation(); }} > ) : null } { e.stopPropagation(); handleDelete(item.id); }} onMouseDown={(e) => { e.stopPropagation(); }} onKeyDown={(e) => { e.stopPropagation(); }} size={ BUTTON_SIZE.xs }> ) } )) } ); } ```