TreeView API

The API documentation of the TreeView React component. Learn more about the props and the CSS customization points.

import { TreeView } from '@material-ui/lab';

Props

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	[]	Expanded node ids.
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.
onNodeToggle	func		Callback fired when a TreeItem is expanded/collapsed. Signature: function(nodeId: string, expanded: boolean) => void nodeId: The id of the toggled node. expanded: The node status - If true the node was expanded. If false the node was collapsed.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

• Style sheet name: MuiTreeView.
• Style sheet details:

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

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Notes

The component can cause issues in StrictMode.

Demos

• Tree View