# muiTreeView

**muiTreeView** gives access to [MUI X Tree
View](https://mui.com/x/react-tree-view/) React components, which lets
users navigate hierarchical lists of data with nested levels that can be
expanded and collapsed.

## Install

You can install the development version of muiTreeView like so:

``` r

remotes::install_github("lgnbhl/muiTreeView")
```

**Read the full documentation with examples
[here](https://felixluginbuhl.com/muiTreeView/).**

## Basic example

``` r

library(muiTreeView)

df <- data.frame(
  pkg = c("muiTreeView", "muiTreeView", "muiTreeView"),
  functions = c("SimpleTreeView", "RichTreeView", "RichTreeView"),
  args = c("items", "items", "onItemSelectionToggle")
)

treeItems <- muiTreeView::asMuiTree(df)

RichTreeView(
  items = treeItems,
  checkboxSelection = TRUE,
  multiSelect = TRUE # FALSE for single select
)
```

![RichTreeView](https://raw.githubusercontent.com/lgnbhl/muiTreeView/refs/heads/main/man/figures/checkboxMultiSelect.png)

## Full documentation

**All the docs with examples are
[here](https://felixluginbuhl.com/muiTreeView/articles/overview.html).**
They follow the structure of the [official MUI X Tree View
documentation](https://mui.com/x/react-tree-view/).

## Contribute

If you have any issue, question or want to contribute with a pull
request, don’t hesitate to write me on
<https://github.com/lgnbhl/muiTreeView>.

For updates follow [Felix
Luginbuhl](https://linkedin.com/in/FelixLuginbuhl) on LinkedIn.

# Package index

## Tree views

The two Tree View components and their items.

- [`SimpleTreeView()`](https://felixluginbuhl.com/muiTreeView/reference/SimpleTreeView.md)
  : SimpleTreeView
- [`RichTreeView()`](https://felixluginbuhl.com/muiTreeView/reference/RichTreeView.md)
  : RichTreeView
- [`TreeItem()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItem.md)
  : TreeItem

## Data frames

Build the `items` of
[`RichTreeView()`](https://felixluginbuhl.com/muiTreeView/reference/RichTreeView.md)
from a data frame.

- [`asMuiTree()`](https://felixluginbuhl.com/muiTreeView/reference/asMuiTree.md)
  : Create choice structure for \[RichTreeView()\]

## Tree Item parts

Components used to build custom Tree Items (see the Tree Item
customization article).

- [`TreeItemContent()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemContent.md)
  : TreeItemContent
- [`TreeItemLabel()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemLabel.md)
  : TreeItemLabel
- [`TreeItemLabelInput()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemLabelInput.md)
  : TreeItemLabelInput
- [`TreeItemCheckbox()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemCheckbox.md)
  : TreeItemCheckbox
- [`TreeItemIcon()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemIcon.md)
  : TreeItemIcon
- [`TreeItemIconContainer()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemIconContainer.md)
  : TreeItemIconContainer
- [`TreeItemGroupTransition()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemGroupTransition.md)
  : TreeItemGroupTransition
- [`TreeItemProvider()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemProvider.md)
  : TreeItemProvider
- [`TreeItemRoot()`](https://felixluginbuhl.com/muiTreeView/reference/TreeItemRoot.md)
  : TreeItemRoot

## Roots and icons

- [`SimpleTreeViewRoot()`](https://felixluginbuhl.com/muiTreeView/reference/SimpleTreeViewRoot.md)
  : SimpleTreeViewRoot
- [`RichTreeViewRoot()`](https://felixluginbuhl.com/muiTreeView/reference/RichTreeViewRoot.md)
  : RichTreeViewRoot
- [`TreeViewCollapseIcon()`](https://felixluginbuhl.com/muiTreeView/reference/TreeViewCollapseIcon.md)
  : TreeViewCollapseIcon
- [`TreeViewExpandIcon()`](https://felixluginbuhl.com/muiTreeView/reference/TreeViewExpandIcon.md)
  : TreeViewExpandIcon

## Shiny and React glue

Dependency helper, printing, and helpers re-exported from `shiny.react`.

- [`muiTreeViewDependency()`](https://felixluginbuhl.com/muiTreeView/reference/muiTreeViewDependency.md)
  : Mui X Tree View JS dependency
- [`print(`*`<muiTreeView>`*`)`](https://felixluginbuhl.com/muiTreeView/reference/print.muiTreeView.md)
  : Print muiTreeView components
- [`reexports`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  [`JS`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  [`reactOutput`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  [`renderReact`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  [`setInput`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  [`triggerEvent`](https://felixluginbuhl.com/muiTreeView/reference/reexports.md)
  : Objects exported from other packages

# Articles

### Get started

- [Overview](https://felixluginbuhl.com/muiTreeView/articles/overview.md):
- [Data frames with
  asMuiTree()](https://felixluginbuhl.com/muiTreeView/articles/data-frames.md):

### Simple Tree View

- [Simple Tree View -
  Items](https://felixluginbuhl.com/muiTreeView/articles/simple-tree-view-items.md):
- [Simple Tree View -
  Selection](https://felixluginbuhl.com/muiTreeView/articles/simple-tree-view-selection.md):
- [Simple Tree View -
  Expansion](https://felixluginbuhl.com/muiTreeView/articles/simple-tree-view-expansion.md):
- [Simple Tree View -
  Customization](https://felixluginbuhl.com/muiTreeView/articles/simple-tree-view-customization.md):

### Rich Tree View

- [Rich Tree View -
  Items](https://felixluginbuhl.com/muiTreeView/articles/rich-tree-view-items.md):
- [Rich Tree View -
  Selection](https://felixluginbuhl.com/muiTreeView/articles/rich-tree-view-selection.md):
- [Rich Tree View -
  Expansion](https://felixluginbuhl.com/muiTreeView/articles/rich-tree-view-expansion.md):
- [Rich Tree View -
  Customization](https://felixluginbuhl.com/muiTreeView/articles/rich-tree-view-customization.md):
- [Rich Tree View - Label
  editing](https://felixluginbuhl.com/muiTreeView/articles/rich-tree-view-editing.md):

### Main features

- [Tree Item
  customization](https://felixluginbuhl.com/muiTreeView/articles/tree-item-customization.md):
- [Accessibility](https://felixluginbuhl.com/muiTreeView/articles/accessibility.md):

### Apps

- [Shiny](https://felixluginbuhl.com/muiTreeView/articles/shiny.md):
- [Navigation with
  reactRouter](https://felixluginbuhl.com/muiTreeView/articles/react-router.md):
- [Theming](https://felixluginbuhl.com/muiTreeView/articles/theming.md):