TreeView API

API documentation for the React TreeView component. Learn about the available props and the CSS API.

Import

import TreeView from '@mui/lab/TreeView';
// or
import { TreeView } from '@mui/lab';

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiTreeView can be used when providing default props or style overrides in the theme.

Props

Props of the native component are also available.

Name	Type	Default	Description
children	node		The content of the component.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
defaultCollapseIcon	node		The default icon used to collapse the node.
defaultEndIcon	node		The default icon displayed next to a end node. This is applied to all tree nodes and can be overridden by the TreeItem `icon` prop.
defaultExpanded	Array<string>	[]	Expanded node ids. (Uncontrolled)
defaultExpandIcon	node		The default icon used to expand the node.
defaultParentIcon	node		The default icon displayed next to a parent node. This is applied to all parent nodes and can be overridden by the TreeItem `icon` prop.
defaultSelected	Array<string> \| string	[]	Selected node ids. (Uncontrolled) When `multiSelect` is true this takes an array of strings; when false (default) a string.
disabledItemsFocusable	bool	false	If `true`, will allow focus on disabled items.
disableSelection	bool	false	If `true` selection is disabled.
expanded	Array<string>		Expanded node ids. (Controlled)
id	string		This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
multiSelect	bool	false	If true `ctrl` and `shift` will trigger multiselect.
onNodeFocus	func		Callback fired when tree items are focused. Signature: `function(event: React.SyntheticEvent, value: string) => void` event: The event source of the callback Warning: This is a generic event not a focus event. value: of the focused node.
onNodeSelect	func		Callback fired when tree items are selected/unselected. Signature: `function(event: React.SyntheticEvent, nodeIds: Array<string> \| string) => void` event: The event source of the callback nodeIds: Ids of the selected nodes. When `multiSelect` is true this is an array of strings; when false (default) a string.
onNodeToggle	func		Callback fired when tree items are expanded/collapsed. Signature: `function(event: React.SyntheticEvent, nodeIds: array) => void` event: The event source of the callback. nodeIds: The ids of the expanded nodes.
selected	Array<string> \| string		Selected node ids. (Controlled) When `multiSelect` is true this takes an array of strings; when false (default) a string.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

CSS

Rule name	Global class	Description
root	.MuiTreeView-root	Styles applied to the root element.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Demos

Tree View