Rich Tree View - Expansion

Handle how users can expand items.

Controlled expansion

Use the expandedItems prop to control the expanded items.

You can use the onExpandedItemsChange prop to listen to changes in the expanded items and update the prop accordingly.

Data Grid
Date and Time Pickers
Charts
Tree View

<Box sx={{ mb: 1 }}>
  <Button onClick={handleExpandClick}>
    {expandedItems.length === 0 ? 'Expand all' : 'Collapse all'}
  </Button>
</Box>
<Box sx={{ minHeight: 200, flexGrow: 1 }}>
  <RichTreeView
    items={MUI_X_PRODUCTS}
    expandedItems={expandedItems}
    onExpandedItemsChange={handleExpandedItemsChange}
  />
</Box>

<Box sx={{ mb: 1 }}>
  <Button onClick={handleExpandClick}>
    {expandedItems.length === 0 ? 'Expand all' : 'Collapse all'}
  </Button>
</Box>
<Box sx={{ minHeight: 200, flexGrow: 1 }}>
  <RichTreeView
    items={MUI_X_PRODUCTS}
    expandedItems={expandedItems}
    onExpandedItemsChange={handleExpandedItemsChange}
  />
</Box>

Press Enter to start editing

Track item expansion change

Use the onItemExpansionToggle prop if you want to react to an item expansion change:

No action recorded

Data Grid
Date and Time Pickers
Charts
Tree View

{action == null ? (
  <Typography>No action recorded</Typography>
) : (
  <Typography>
    Last action: {action.isExpanded ? 'expand' : 'collapse'} {action.itemId}
  </Typography>
)}
<Box sx={{ minHeight: 200, minWidth: 300, flexGrow: 1 }}>
  <RichTreeView
    items={MUI_X_PRODUCTS}
    onItemExpansionToggle={handleItemExpansionToggle}
  />
</Box>

{action == null ? (
  <Typography>No action recorded</Typography>
) : (
  <Typography>
    Last action: {action.isExpanded ? 'expand' : 'collapse'} {action.itemId}
  </Typography>
)}
<Box sx={{ minHeight: 200, minWidth: 300, flexGrow: 1 }}>
  <RichTreeView
    items={MUI_X_PRODUCTS}
    onItemExpansionToggle={handleItemExpansionToggle}
  />
</Box>

Press Enter to start editing

Change item expansion

You can use the setItemExpansion API method to imperatively change the expansion of an item:

Data Grid
Date and Time Pickers

<Stack sx={{ mb: 1 }} spacing={2} direction="row">
  <Button onClick={handleExpandClick}>Expand Data Grid</Button>
  <Button onClick={handleCollapseClick}>Collapse Data Grid</Button>
</Stack>
<Box sx={{ minHeight: 220, flexGrow: 1 }}>
  <RichTreeView items={MUI_X_PRODUCTS} apiRef={apiRef} />
</Box>

<Stack sx={{ mb: 1 }} spacing={2} direction="row">
  <Button onClick={handleExpandClick}>Expand Data Grid</Button>
  <Button onClick={handleCollapseClick}>Collapse Data Grid</Button>
</Stack>
<Box sx={{ minHeight: 220, flexGrow: 1 }}>
  <RichTreeView items={MUI_X_PRODUCTS} apiRef={apiRef} />
</Box>

Press Enter to start editing

API

See the documentation below for a complete reference to all of the props and classes available to the components mentioned here.