TreeItemAPI
React TreeItem 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import { TreeItem } from '@mui/x-tree-view/TreeItem';
// or
import { TreeItem } from '@mui/x-tree-view';
// or
import { TreeItem } from '@mui/x-tree-view-pro';
通过阅读此关于最小化捆绑包大小的指南,了解它们之间的区别。
原生组件的 Props 也可用。
名称 | 类型 | 默认 | 描述 |
---|---|---|---|
itemId* | string | - | 项目的 id。 |
children | node | - | 组件的内容。 |
classes | object | - | 覆盖或扩展应用于组件的样式。 有关更多详细信息,请参阅下方的CSS 类 API。 |
ContentComponent | 元素类型 | TreeItemContent | 用于渲染项目内容的组件。 |
ContentProps | object | - | 应用于 ContentComponent 的 Props。 |
disabled | bool | false | 如果为 |
label | node | - | 树项目标签。 |
onFocus | unsupportedProp | - | 不支持此 prop。如果您需要监视项目的焦点,请使用树上的 |
onKeyDown | func | - | 当在项目上按下键盘上的键时触发的回调。 |
slotProps | object | {} | 用于每个组件插槽的 props。 |
slots | object | {} | 可覆盖的组件插槽。 有关更多详细信息,请参阅下方的插槽 API。 |
sx | Array<func | object | bool> | func | object | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关更多详细信息,请参阅 `sx` 页面。 |
ref
被转发到根元素。主题默认 props
您可以使用 MuiTreeItem
通过主题更改此组件的默认 props。
插槽名称 | 类名 | 默认组件 | 描述 |
---|---|---|---|
collapseIcon | 用于折叠项目的图标。 | ||
expandIcon | 用于展开项目的图标。 | ||
endIcon | 显示在末尾项目旁边的图标。 | ||
icon | 显示在树项目标签旁边的图标。 | ||
groupTransition | .MuiTreeItem-groupTransition | TreeItem2Group | 动画显示/消失项目子组件的组件。 |
这些类名对于使用 CSS 设置样式很有用。当触发特定状态时,它们将应用于组件的插槽。
类名 | 规则名称 | 描述 |
---|---|---|
.Mui-disabled | 禁用时应用于元素的 State 类。 | |
.Mui-expanded | 展开时应用于内容元素的 State 类。 | |
.Mui-focused | 聚焦时应用于内容元素的 State 类。 | |
.Mui-selected | 选中时应用于内容元素的 State 类。 | |
.MuiTreeItem-checkbox | checkbox | 应用于 checkbox 元素的样式。 |
.MuiTreeItem-content | content | 应用于 content 元素的样式。 |
.MuiTreeItem-dragAndDropOverlay | dragAndDropOverlay | 应用于拖放 overlay 的样式。 |
.MuiTreeItem-editable | editable | 应用于可编辑项目的内容的样式。 |
.MuiTreeItem-editing | editing | 启用编辑时应用于 content 元素的样式。 |
.MuiTreeItem-iconContainer | iconContainer | 应用于树项目图标的样式。 |
.MuiTreeItem-label | label | 应用于 label 元素的样式。 |
.MuiTreeItem-labelInput | labelInput | 启用编辑时应用于可见的 input 元素的样式。 |
.MuiTreeItem-root | root | 应用于根元素的样式。 |
您可以使用以下自定义选项之一覆盖组件的样式
- 使用全局类名。
- 使用规则名称作为自定义主题中组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中找不到所需的信息,请考虑查看组件的实现以获取更多详细信息。