TreeItem API

API reference docs for the React TreeItem component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

Props of the native component are also available.

Name	Type	Default	Description
nodeId^*	string		The id of the node.
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.
collapseIcon	node		The icon used to collapse the node.
ContentComponent	element type	TreeItemContent	The component used for the content node. ⚠️ Needs to be able to hold a ref.
ContentProps	object		Props applied to ContentComponent
disabled	bool	false	If `true`, the node is disabled.
endIcon	node		The icon displayed next to a end node.
expandIcon	node		The icon used to expand the node.
icon	node		The icon to display next to the tree node's label.
label	node		The tree node label.
onFocus	unsupportedProp		This prop isn't supported. Use the `onNodeFocus` callback on the tree if you need to monitor a node's focus.
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.
TransitionComponent	elementType	Collapse	The component used for the transition. Follow this guide to learn more about the requirements for this component.
TransitionProps	object		Props applied to the transition element. By default, the element is based on this `Transition` component.

The ref is forwarded to the root element.

You can use MuiTreeItem to change the default props of this component with the theme.

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule name	Global class	Description
root	.MuiTreeItem-root	Styles applied to the root element.
group	.MuiTreeItem-group	Styles applied to the transition component.
content	.MuiTreeItem-content	Styles applied to the content element.
expanded STATE	.Mui-expanded	State class applied to the content element when expanded.
selected STATE	.Mui-selected	State class applied to the content element when selected.
focused STATE	.Mui-focused	State class applied to the content element when focused.
disabled STATE	.Mui-disabled	State class applied to the element when disabled.
iconContainer	.MuiTreeItem-iconContainer	Styles applied to the tree node icon.
label	.MuiTreeItem-label	Styles applied to the label 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.