Skip to content

🎉 Material UI v5 is out! Head to the migration guide to get started.

TreeItem API

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

Import

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

You can learn more about the difference by reading this guide.

Component name

The MuiTreeItem name can be used for providing default props or style overrides at the theme level.

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.
collapseIcon node The icon used to collapse the node.
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.
nodeId* string The id of the node.
onIconClick func onClick handler for the icon container. Call event.preventDefault() to prevent onNodeToggle from being called.
onLabelClick func onClick handler for the label container. Call event.preventDefault() to prevent onNodeToggle from being called.
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.

The ref is forwarded to the root element.

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

CSS

Rule name Global class Description
root .MuiTreeItem-root Styles applied to the root element.
expanded .Mui-expanded Pseudo-class applied to the root element when expanded.
selected .Mui-selected Pseudo-class applied to the root element when selected.
group .MuiTreeItem-group Styles applied to the role="group" element.
content .MuiTreeItem-content Styles applied to the tree node content.
iconContainer .MuiTreeItem-iconContainer Styles applied to the tree node icon and collapse/expand icon.
label .MuiTreeItem-label Styles applied to the label element.

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

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

Demos