Package-level declarations

Types

Link copied to clipboard
external interface AddItemsParameters<R : Any>
Link copied to clipboard
external interface RichTreeViewClasses
Link copied to clipboard
external interface RichTreeViewItemsOwnerState

The owner state handed to the item slot's props resolver.

Link copied to clipboard
external interface RichTreeViewItemsSlotProps : Props
Link copied to clipboard
external interface RichTreeViewItemsSlots
Link copied to clipboard

The owner state of the loading slot.

Link copied to clipboard

The props of the loading slot: the div props plus the two the loading UI reads (SlotComponentProps<'div', RichTreeViewLoadingSlotOwnProps, …> upstream).

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface RichTreeViewPublicAPI<R : Any> : TreeViewPublicAPI<R>

The API of RichTreeViewStore: everything of TreeViewPublicAPI plus label editing and imperative item updates.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface SetIsItemDisabledParameters
Link copied to clipboard
external interface SetItemExpansionParameters
Link copied to clipboard
external interface SetItemSelectionParameters
Link copied to clipboard
external interface SimpleTreeViewClasses
Link copied to clipboard
external interface SimpleTreeViewItem

The item model of a SimpleTreeView (SimpleTreeViewItem of internals/SimpleTreeViewStore).

Link copied to clipboard
Link copied to clipboard
external interface SimpleTreeViewSlots : TreeViewSlots
Link copied to clipboard
sealed external interface SlotComponentProps<P : Props, S>

The props of a slot: a props object, or a function of the slot's owner state that returns one (SlotComponentProps<Component, Overrides, OwnerState> from @mui/utils/types).

Link copied to clipboard
external interface TreeItemClasses
Link copied to clipboard

The data-* attributes useTreeItem puts on the item's content element while the matching status is on (data-expanded="", …), for attribute selectors in styles and DOM queries.

Link copied to clipboard
external interface TreeItemIconProps : Props
Link copied to clipboard
external interface TreeItemIconSlotProps : Props
Link copied to clipboard
external interface TreeItemIconSlots
Link copied to clipboard
external interface TreeItemLabelInputProps : Props
Link copied to clipboard
external interface TreeItemLoaderClasses
Link copied to clipboard
external interface TreeItemLoaderOwnerState
Link copied to clipboard
Link copied to clipboard
external interface TreeItemOwnerState
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface TreeItemSlots : TreeItemIconSlots
Link copied to clipboard
external interface TreeViewClasses
Link copied to clipboard

The CSS custom properties the Tree View sets at runtime, for styles that need to read them: the root carries itemChildrenIndentation (useTreeViewRootProps), every item root carries itemDepth and, when the itemHeight prop is set, itemHeight (useTreeItem). Nothing in the package declares them, so they are listed here.

Link copied to clipboard
sealed external interface TreeViewDOMStructure
Link copied to clipboard
sealed external interface TreeViewExpansionTrigger
Link copied to clipboard
Link copied to clipboard
sealed external interface TreeViewItemSelectionStatus
Link copied to clipboard
sealed external interface TreeViewItemsReorderingAction
Link copied to clipboard
external interface TreeViewPublicAPI<out R : Any>

The object apiRef points at once the Tree View has rendered: the API of MinimalTreeViewStore, shared by SimpleTreeView and RichTreeView (TreeViewPublicAPI<TStore> upstream).

Link copied to clipboard
external interface TreeViewSelectionPropagation
Link copied to clipboard
sealed external interface TreeViewSelectionValue
Link copied to clipboard
external interface TreeViewSlotProps : Props
Link copied to clipboard
external interface TreeViewSlots
Link copied to clipboard
external interface TreeViewStoreParameters : Props
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface TreeViewStyleContextValue
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface UseTreeItemReturnValue
Link copied to clipboard
external interface UseTreeItemStatus

Properties

Link copied to clipboard

defaultMuiPrevented of an event received by a Tree View handler, see TreeViewCancellableEvent.

Link copied to clipboard

Demos:

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external val TreeItem: FC<TreeItemProps>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Semantic wrapper for one loading row of the Rich Tree View.

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
inline fun <P : Props, S> SlotComponentProps(props: P): SlotComponentProps<P, S>
inline fun <P : Props, S> SlotComponentProps(noinline resolve: (ownerState: S) -> P): SlotComponentProps<P, S>
Link copied to clipboard

Creates the ref to pass to the apiRef prop of the RichTreeView component.

Link copied to clipboard

Creates the ref to pass to the apiRef prop of the SimpleTreeView component.