跳转到内容

TreeItem API

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

Import

import TreeItem from '@mui/lab/TreeItem';
// 或
import { TreeItem } from '@mui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
nodeId*string
The id of the node.
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
collapseIconnode
The icon used to collapse the node.
ContentComponentelement typeTreeItemContent
The component used for the content node.
⚠️ Needs to be able to hold a ref.
ContentPropsobject
Props applied to ContentComponent
disabledboolfalse
If true, the node is disabled.
endIconnode
The icon displayed next to a end node.
expandIconnode
The icon used to expand the node.
iconnode
The icon to display next to the tree node's label.
labelnode
The tree node label.
onFocusunsupportedProp
This prop isn't supported. Use the onNodeFocus callback on the tree if you need to monitor a node's focus.
sxobject
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponentelementTypeCollapse
The component used for the transition. Follow this guide to learn more about the requirements for this component.
TransitionPropsobject
Props applied to the transition element. By default, the element is based on this Transition component.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiTreeItem-rootStyles applied to the root element.
group.MuiTreeItem-groupStyles applied to the transition component.
content.MuiTreeItem-contentStyles applied to the content element.
expanded.Mui-expandedPseudo-class applied to the content element when expanded.
selected.Mui-selectedPseudo-class applied to the content element when selected.
focused.Mui-focusedPseudo-class applied to the content element when focused.
disabled.Mui-disabledPseudo-class applied to the element when disabled.
iconContainer.MuiTreeItem-iconContainerStyles applied to the tree node icon.
label.MuiTreeItem-labelStyles applied to the label element.

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

Demos