Skip to content

TreeView API

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

Import

import TreeView from '@material-ui/lab/TreeView';
// or
import { TreeView } from '@material-ui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

NameTypeDefaultDescription
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
defaultCollapseIconnodeThe default icon used to collapse the node.
defaultEndIconnodeThe default icon displayed next to a end node. This is applied to all tree nodes and can be overridden by the TreeItem icon prop.
defaultExpandedArray<string>[]Expanded node ids. (Uncontrolled)
defaultExpandIconnodeThe default icon used to expand the node.
defaultParentIconnodeThe 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.
disabledItemsFocusableboolfalseIf true, will allow focus on disabled items.
disableSelectionboolfalseIf true selection is disabled.
expandedArray<string>Expanded node ids. (Controlled)
idstringThis prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id.
multiSelectboolfalseIf true ctrl and shift will trigger multiselect.
onNodeFocusfuncCallback 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.
onNodeSelectfuncCallback 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.
onNodeTogglefuncCallback 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.
sxobjectThe system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiTreeView-rootStyles applied to the root element.

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

Demos