Pular para o conteúdo

TreeView API

Documentação da API para o componente React TreeView . Aprenda sobre as propriedades disponíveis e a API CSS.

Importação

import TreeView from '@mui/lab/TreeView';
// ou
import { TreeView } from '@mui/lab';
Você pode aprender sobre a diferença lendo este guia sobre como minimizar o tamanho do pacote.

Nome do componente

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

Propriedades

Propriedades do componente nativo também estão disponíveis.

NomeTipoPadrãoDescrição
childrennode
O conteúdo do componente.
classesobject
Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes.
defaultCollapseIconnode
O ícone padrão usado para recolher o nó.
defaultEndIconnode
O ícone padrão mostrado perto do fim do nó. Isso é aplicado para todas os nós de árvores e pode ser substituído pelo ThreeItem icon.
defaultExpandedArray<string>[]
Expanded node ids. (Uncontrolled)
defaultExpandIconnode
The default icon used to expand the node.
defaultParentIconnode
The default icon displayed next to a parent node. This is applied to all parent nodes and can be overridden by the TreeItem icon prop.
defaultSelectedArray<string>
| string
[]
Selected node ids. (Uncontrolled) When multiSelect is true this takes an array of strings; when false (default) a string.
disabledItemsFocusableboolfalse
If true, will allow focus on disabled items.
disableSelectionboolfalse
If true selection is disabled.
expandedArray<string>
Expanded node ids. (Controlled)
idstring
This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
multiSelectboolfalse
If true ctrl and shift will trigger multiselect.
onNodeFocusfunc
Callback fired when tree items are focused.

Signature:
function(event: object, value: string) => void
event: The event source of the callback Warning: This is a generic event not a focus event.
value: of the focused node.
onNodeSelectfunc
Callback fired when tree items are selected/unselected.

Signature:
function(event: object, value: array | string) => void
event: The event source of the callback
value: of the selected nodes. When multiSelect is true this is an array of strings; when false (default) a string.
onNodeTogglefunc
Callback fired when tree items are expanded/collapsed.

Signature:
function(event: object, nodeIds: array) => void
event: The event source of the callback.
nodeIds: The ids of the expanded nodes.
selectedArray<string>
| string
Selected node ids. (Controlled) When multiSelect is true this takes an array of strings; when false (default) a string.
sxArray<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.

O ref é encaminhado para o elemento raiz.

CSS

Nome da regraClasse globalDescrição
root.MuiTreeView-rootEstilos aplicados ao elemento raiz.

Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:

Demonstrações