TreeItem API
API documentation for the React TreeItem component. Learn about the available props, and the CSS API.
Import
import TreeItem from '@material-ui/lab/TreeItem';
// o
import { TreeItem } from '@material-ui/lab';
Component name
The nameMuiTreeItem
can be used when providing default props or style overrides in the theme.Props
Nombre | Tipo | Por defecto | Descripción |
---|---|---|---|
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. | |
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.Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Descripción |
---|---|---|
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 | .Mui-expanded | Pseudo-class applied to the content element when expanded. |
selected | .Mui-selected | Pseudo-class applied to the content element when selected. |
focused | .Mui-focused | Pseudo-class applied to the content element when focused. |
disabled | .Mui-disabled | Pseudo-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 rule name of the
classes
object prop. - With a global class name.
- With a theme and an
styleOverrides
property.