@mui/x-tree-view 8.0.0-alpha.9 → 8.0.0-beta.0

package/{node → esm}/internals/hooks/useInstanceEventHandler.js

@@ -1,24 +1,16 @@
-"use strict";
-
-var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createUseInstanceEventHandler = createUseInstanceEventHandler;
-exports.useInstanceEventHandler = exports.unstable_resetCleanupTracking = void 0;
-var React = _interopRequireWildcard(require("react"));
-var _TimerBasedCleanupTracking = require("../utils/cleanupTracking/TimerBasedCleanupTracking");
-var _FinalizationRegistryBasedCleanupTracking = require("../utils/cleanupTracking/FinalizationRegistryBasedCleanupTracking");
+import * as React from 'react';
+import { TimerBasedCleanupTracking } from "../utils/cleanupTracking/TimerBasedCleanupTracking.js";
+import { FinalizationRegistryBasedCleanupTracking } from "../utils/cleanupTracking/FinalizationRegistryBasedCleanupTracking.js";
 // We use class to make it easier to detect in heap snapshots by name
 class ObjectToBeRetainedByReact {}
 
 // Based on https://github.com/Bnaya/use-dispose-uncommitted/blob/main/src/finalization-registry-based-impl.ts
 // Check https://github.com/facebook/react/issues/15317 to get more information
-function createUseInstanceEventHandler(registryContainer) {
+export function createUseInstanceEventHandler(registryContainer) {
   let cleanupTokensCounter = 0;
   return function useInstanceEventHandler(instance, eventName, handler) {
     if (registryContainer.registry === null) {
-      registryContainer.registry = typeof FinalizationRegistry !== 'undefined' ? new _FinalizationRegistryBasedCleanupTracking.FinalizationRegistryBasedCleanupTracking() : new _TimerBasedCleanupTracking.TimerBasedCleanupTracking();
+      registryContainer.registry = typeof FinalizationRegistry !== 'undefined' ? new FinalizationRegistryBasedCleanupTracking() : new TimerBasedCleanupTracking();
     }
     const [objectRetainedByReact] = React.useState(new ObjectToBeRetainedByReact());
     const subscription = React.useRef(null);
@@ -78,9 +70,8 @@ const registryContainer = {
 };
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const unstable_resetCleanupTracking = () => {
+export const unstable_resetCleanupTracking = () => {
   registryContainer.registry?.reset();
   registryContainer.registry = null;
 };
-exports.unstable_resetCleanupTracking = unstable_resetCleanupTracking;
-const useInstanceEventHandler = exports.useInstanceEventHandler = createUseInstanceEventHandler(registryContainer);
+export const useInstanceEventHandler = createUseInstanceEventHandler(registryContainer);

package/esm/internals/hooks/useLazyRef.d.ts

@@ -0,0 +1 @@
+export { default as useLazyRef } from '@mui/utils/useLazyRef';

package/esm/internals/hooks/useLazyRef.js

@@ -0,0 +1 @@
+export { default as useLazyRef } from '@mui/utils/useLazyRef';

package/esm/internals/hooks/useOnMount.d.ts

@@ -0,0 +1 @@
+export { default as useOnMount } from '@mui/utils/useOnMount';

package/esm/internals/hooks/useOnMount.js

@@ -0,0 +1 @@
+export { default as useOnMount } from '@mui/utils/useOnMount';

package/esm/internals/hooks/useSelector.d.ts

@@ -0,0 +1,4 @@
+import { TreeViewAnyPluginSignature, TreeViewState } from "../models/index.js";
+import { TreeViewStore } from "../utils/TreeViewStore.js";
+import { TreeViewSelector } from "../utils/selectors.js";
+export declare const useSelector: <TSignatures extends readonly TreeViewAnyPluginSignature[], TArgs, TValue>(store: TreeViewStore<TSignatures>, selector: TreeViewSelector<TreeViewState<TSignatures>, TArgs, TValue>, args?: TArgs, equals?: (a: TValue, b: TValue) => boolean) => TValue;

package/esm/internals/hooks/useSelector.js

@@ -0,0 +1,9 @@
+// use-sync-external-store has no exports field defined
+// See https://github.com/facebook/react/issues/30698
+// eslint-disable-next-line import/extensions
+import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/with-selector.js';
+const defaultCompare = Object.is;
+export const useSelector = (store, selector, args = undefined, equals = defaultCompare) => {
+  const selectorWithArgs = state => selector(state, args);
+  return useSyncExternalStoreWithSelector(store.subscribe, store.getSnapshot, store.getSnapshot, selectorWithArgs, equals);
+};

package/esm/internals/hooks/useTimeout.d.ts

@@ -0,0 +1 @@
+export { default as useTimeout } from '@mui/utils/useTimeout';

package/esm/internals/hooks/useTimeout.js

@@ -0,0 +1 @@
+export { default as useTimeout } from '@mui/utils/useTimeout';

package/esm/internals/index.d.ts

@@ -0,0 +1,33 @@
+export { useTreeView } from "./useTreeView/index.js";
+export { TreeViewProvider, useTreeViewContext } from "./TreeViewProvider/index.js";
+export { RichTreeViewItems } from "./components/RichTreeViewItems.js";
+export type { RichTreeViewItemsSlots, RichTreeViewItemsSlotProps } from './components/RichTreeViewItems';
+export { unstable_resetCleanupTracking, useInstanceEventHandler } from "./hooks/useInstanceEventHandler.js";
+export { useSelector } from "./hooks/useSelector.js";
+export type { TreeViewPlugin, TreeViewPluginSignature, ConvertPluginsIntoSignatures, MergeSignaturesProperty, TreeViewPublicAPI, TreeViewState, TreeViewExperimentalFeatures, TreeViewItemMeta, TreeViewInstance, TreeViewItemPlugin, TreeViewUsedStore } from './models';
+export type { TreeViewCorePluginParameters } from './corePlugins';
+export { useTreeViewExpansion } from "./plugins/useTreeViewExpansion/index.js";
+export type { UseTreeViewExpansionSignature, UseTreeViewExpansionParameters } from './plugins/useTreeViewExpansion';
+export { useTreeViewSelection } from "./plugins/useTreeViewSelection/index.js";
+export type { UseTreeViewSelectionSignature, UseTreeViewSelectionParameters } from './plugins/useTreeViewSelection';
+export { useTreeViewFocus } from "./plugins/useTreeViewFocus/index.js";
+export type { UseTreeViewFocusSignature, UseTreeViewFocusParameters } from './plugins/useTreeViewFocus';
+export { useTreeViewKeyboardNavigation } from "./plugins/useTreeViewKeyboardNavigation/index.js";
+export type { UseTreeViewKeyboardNavigationSignature } from './plugins/useTreeViewKeyboardNavigation';
+export { useTreeViewIcons } from "./plugins/useTreeViewIcons/index.js";
+export type { UseTreeViewIconsSignature, UseTreeViewIconsParameters } from './plugins/useTreeViewIcons';
+export { useTreeViewItems, buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./plugins/useTreeViewItems/index.js";
+export { selectorItemMetaLookup, selectorItemMeta, selectorItemIndex, selectorItemOrderedChildrenIds } from "./plugins/useTreeViewItems/useTreeViewItems.selectors.js";
+export type { UseTreeViewItemsSignature, UseTreeViewItemsParameters, UseTreeViewItemsState } from './plugins/useTreeViewItems';
+export { useTreeViewLabel } from "./plugins/useTreeViewLabel/index.js";
+export type { UseTreeViewLabelSignature, UseTreeViewLabelParameters } from './plugins/useTreeViewLabel';
+export { selectorIsItemExpanded } from "./plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.js";
+export { selectorIsItemSelected } from "./plugins/useTreeViewSelection/useTreeViewSelection.selectors.js";
+export { selectorDataSourceState, selectorGetTreeItemError } from "./plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.js";
+export type { UseTreeViewLazyLoadingSignature } from './plugins/useTreeViewLazyLoading';
+export type { UseTreeViewLazyLoadingParameters } from './plugins/useTreeViewLazyLoading';
+export { useTreeViewJSXItems } from "./plugins/useTreeViewJSXItems/index.js";
+export type { UseTreeViewJSXItemsSignature, UseTreeViewJSXItemsParameters } from './plugins/useTreeViewJSXItems';
+export { createSelector } from "./utils/selectors.js";
+export { isTargetInDescendants } from "./utils/tree.js";
+export { TreeViewStore } from "./utils/TreeViewStore.js";

package/esm/internals/index.js

@@ -0,0 +1,24 @@
+export { useTreeView } from "./useTreeView/index.js";
+export { TreeViewProvider, useTreeViewContext } from "./TreeViewProvider/index.js";
+export { RichTreeViewItems } from "./components/RichTreeViewItems.js";
+export { unstable_resetCleanupTracking, useInstanceEventHandler } from "./hooks/useInstanceEventHandler.js";
+export { useSelector } from "./hooks/useSelector.js";
+
+// Core plugins
+
+// Plugins
+export { useTreeViewExpansion } from "./plugins/useTreeViewExpansion/index.js";
+export { useTreeViewSelection } from "./plugins/useTreeViewSelection/index.js";
+export { useTreeViewFocus } from "./plugins/useTreeViewFocus/index.js";
+export { useTreeViewKeyboardNavigation } from "./plugins/useTreeViewKeyboardNavigation/index.js";
+export { useTreeViewIcons } from "./plugins/useTreeViewIcons/index.js";
+export { useTreeViewItems, buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "./plugins/useTreeViewItems/index.js";
+export { selectorItemMetaLookup, selectorItemMeta, selectorItemIndex, selectorItemOrderedChildrenIds } from "./plugins/useTreeViewItems/useTreeViewItems.selectors.js";
+export { useTreeViewLabel } from "./plugins/useTreeViewLabel/index.js";
+export { selectorIsItemExpanded } from "./plugins/useTreeViewExpansion/useTreeViewExpansion.selectors.js";
+export { selectorIsItemSelected } from "./plugins/useTreeViewSelection/useTreeViewSelection.selectors.js";
+export { selectorDataSourceState, selectorGetTreeItemError } from "./plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.selectors.js";
+export { useTreeViewJSXItems } from "./plugins/useTreeViewJSXItems/index.js";
+export { createSelector } from "./utils/selectors.js";
+export { isTargetInDescendants } from "./utils/tree.js";
+export { TreeViewStore } from "./utils/TreeViewStore.js";

package/esm/internals/models/events.d.ts

@@ -0,0 +1,9 @@
+import * as React from 'react';
+export interface TreeViewEventLookupElement {
+  params: object;
+}
+export type TreeViewEventListener<E extends TreeViewEventLookupElement> = (params: E['params'], event: MuiEvent<{}>) => void;
+export type MuiBaseEvent = React.SyntheticEvent<HTMLElement> | DocumentEventMap[keyof DocumentEventMap] | {};
+export type MuiEvent<E extends MuiBaseEvent = MuiBaseEvent> = E & {
+  defaultMuiPrevented?: boolean;
+};

package/esm/internals/models/events.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/models/helpers.d.ts

@@ -0,0 +1,7 @@
+import type { TreeViewAnyPluginSignature, TreeViewPlugin } from './plugin';
+type IsAny<T> = 0 extends 1 & T ? true : false;
+export type OptionalIfEmpty<A extends string, B> = keyof B extends never ? Partial<Record<A, B>> : IsAny<B> extends true ? Partial<Record<A, B>> : Record<A, B>;
+export type MergeSignaturesProperty<TSignatures extends readonly any[], TProperty extends keyof TreeViewAnyPluginSignature> = TSignatures extends readonly [plugin: infer P, ...otherPlugin: infer R] ? P extends TreeViewAnyPluginSignature ? P[TProperty] & MergeSignaturesProperty<R, TProperty> : {} : {};
+export type ConvertPluginsIntoSignatures<TPlugins extends readonly TreeViewPlugin<TreeViewAnyPluginSignature>[]> = TPlugins extends readonly [plugin: infer TPlugin, ...otherPlugin: infer R] ? R extends readonly TreeViewPlugin<any>[] ? TPlugin extends TreeViewPlugin<infer TSignature> ? readonly [TSignature, ...ConvertPluginsIntoSignatures<R>] : never : never : [];
+export type ConvertSignaturesIntoPlugins<TSignatures extends readonly TreeViewAnyPluginSignature[]> = TSignatures extends readonly [signature: infer TSignature, ...otherSignatures: infer R] ? R extends readonly TreeViewAnyPluginSignature[] ? TSignature extends TreeViewAnyPluginSignature ? readonly [TreeViewPlugin<TSignature>, ...ConvertSignaturesIntoPlugins<R>] : never : never : [];
+export {};

package/esm/internals/models/helpers.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/models/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./helpers.js";
+export * from "./plugin.js";
+export * from "./itemPlugin.js";
+export * from "./treeView.js";

package/esm/internals/models/index.js

@@ -0,0 +1,4 @@
+export * from "./helpers.js";
+export * from "./plugin.js";
+export * from "./itemPlugin.js";
+export * from "./treeView.js";

package/esm/internals/models/itemPlugin.d.ts

@@ -0,0 +1,43 @@
+import * as React from 'react';
+import { EventHandlers } from '@mui/utils/types';
+import type { UseTreeItemContentSlotOwnProps, UseTreeItemDragAndDropOverlaySlotOwnProps, UseTreeItemLabelInputSlotOwnProps, UseTreeItemRootSlotOwnProps, UseTreeItemCheckboxSlotOwnProps, UseTreeItemStatus } from '../../useTreeItem';
+import type { UseTreeItemInteractions } from '../../hooks/useTreeItemUtils/useTreeItemUtils';
+import type { TreeItemProps } from '../../TreeItem/TreeItem.types';
+export interface TreeViewItemPluginSlotPropsEnhancerParams {
+  rootRefObject: React.RefObject<HTMLLIElement | null>;
+  contentRefObject: React.RefObject<HTMLDivElement | null>;
+  externalEventHandlers: EventHandlers;
+  interactions: UseTreeItemInteractions;
+  status: UseTreeItemStatus;
+}
+type TreeViewItemPluginSlotPropsEnhancer<TSlotProps> = (params: TreeViewItemPluginSlotPropsEnhancerParams) => Partial<TSlotProps>;
+export interface TreeViewItemPluginSlotPropsEnhancers {
+  root?: TreeViewItemPluginSlotPropsEnhancer<UseTreeItemRootSlotOwnProps>;
+  content?: TreeViewItemPluginSlotPropsEnhancer<UseTreeItemContentSlotOwnProps>;
+  dragAndDropOverlay?: TreeViewItemPluginSlotPropsEnhancer<UseTreeItemDragAndDropOverlaySlotOwnProps>;
+  labelInput?: TreeViewItemPluginSlotPropsEnhancer<UseTreeItemLabelInputSlotOwnProps>;
+  checkbox?: TreeViewItemPluginSlotPropsEnhancer<UseTreeItemCheckboxSlotOwnProps>;
+}
+export interface TreeViewItemPluginResponse {
+  /**
+   * Root of the `content` slot enriched by the plugin.
+   */
+  contentRef?: React.RefCallback<HTMLElement> | null;
+  /**
+   * Ref of the `root` slot enriched by the plugin
+   */
+  rootRef?: React.RefCallback<HTMLLIElement> | null;
+  /**
+   * Callback to enhance the slot props of the Tree Item.
+   *
+   * Not all slots are enabled by default,
+   * if a new plugin needs to pass to an unconfigured slot,
+   * it just needs to be added to `TreeViewItemPluginSlotPropsEnhancers`
+   */
+  propsEnhancers?: TreeViewItemPluginSlotPropsEnhancers;
+}
+export interface TreeViewItemPluginOptions extends Omit<TreeViewItemPluginResponse, 'propsEnhancers'> {
+  props: TreeItemProps;
+}
+export type TreeViewItemPlugin = (options: TreeViewItemPluginOptions) => void | TreeViewItemPluginResponse;
+export {};

package/esm/internals/models/itemPlugin.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/models/plugin.d.ts

@@ -0,0 +1,151 @@
+import * as React from 'react';
+import { EventHandlers } from '@mui/utils/types';
+import { TreeViewExperimentalFeatures, TreeViewInstance, TreeViewModel } from "./treeView.js";
+import type { MergeSignaturesProperty, OptionalIfEmpty } from './helpers';
+import { TreeViewEventLookupElement } from "./events.js";
+import type { TreeViewCorePluginSignatures } from '../corePlugins';
+import { TreeViewItemPlugin } from "./itemPlugin.js";
+import { TreeViewItemId } from "../../models/index.js";
+import { TreeViewStore } from "../utils/TreeViewStore.js";
+export interface TreeViewPluginOptions<TSignature extends TreeViewAnyPluginSignature> {
+  instance: TreeViewUsedInstance<TSignature>;
+  params: TreeViewUsedDefaultizedParams<TSignature>;
+  slots: TSignature['slots'];
+  slotProps: TSignature['slotProps'];
+  experimentalFeatures: TreeViewUsedExperimentalFeatures<TSignature>;
+  models: TreeViewUsedModels<TSignature>;
+  store: TreeViewUsedStore<TSignature>;
+  rootRef: React.RefObject<HTMLUListElement | null>;
+  plugins: TreeViewPlugin<TreeViewAnyPluginSignature>[];
+}
+type TreeViewModelsInitializer<TSignature extends TreeViewAnyPluginSignature> = { [TControlled in keyof TSignature['models']]: {
+  getDefaultValue: (params: TSignature['defaultizedParams']) => Exclude<TSignature['defaultizedParams'][TControlled], undefined>;
+} };
+type TreeViewResponse<TSignature extends TreeViewAnyPluginSignature> = {
+  getRootProps?: <TOther extends EventHandlers = {}>(otherHandlers: TOther) => React.HTMLAttributes<HTMLUListElement>;
+} & OptionalIfEmpty<'publicAPI', TSignature['publicAPI']> & OptionalIfEmpty<'instance', TSignature['instance']> & OptionalIfEmpty<'contextValue', TSignature['contextValue']>;
+export type TreeViewPluginSignature<T extends {
+  params?: {};
+  defaultizedParams?: {};
+  instance?: {};
+  publicAPI?: {};
+  events?: { [key in keyof T['events']]: TreeViewEventLookupElement };
+  state?: {};
+  cache?: {};
+  contextValue?: {};
+  slots?: { [key in keyof T['slots']]: React.ElementType };
+  slotProps?: { [key in keyof T['slotProps']]: {} | (() => {}) };
+  modelNames?: keyof T['defaultizedParams'];
+  experimentalFeatures?: string;
+  dependencies?: readonly TreeViewAnyPluginSignature[];
+  optionalDependencies?: readonly TreeViewAnyPluginSignature[];
+}> = {
+  params: T extends {
+    params: {};
+  } ? T['params'] : {};
+  defaultizedParams: T extends {
+    defaultizedParams: {};
+  } ? T['defaultizedParams'] : {};
+  instance: T extends {
+    instance: {};
+  } ? T['instance'] : {};
+  publicAPI: T extends {
+    publicAPI: {};
+  } ? T['publicAPI'] : {};
+  events: T extends {
+    events: {};
+  } ? T['events'] : {};
+  state: T extends {
+    state: {};
+  } ? T['state'] : {};
+  cache: T extends {
+    cache: {};
+  } ? T['cache'] : {};
+  contextValue: T extends {
+    contextValue: {};
+  } ? T['contextValue'] : {};
+  slots: T extends {
+    slots: {};
+  } ? T['slots'] : {};
+  slotProps: T extends {
+    slotProps: {};
+  } ? T['slotProps'] : {};
+  models: T extends {
+    defaultizedParams: {};
+    modelNames: keyof T['defaultizedParams'];
+  } ? { [TControlled in T['modelNames']]-?: TreeViewModel<Exclude<T['defaultizedParams'][TControlled], undefined>> } : {};
+  experimentalFeatures: T extends {
+    experimentalFeatures: string;
+  } ? { [key in T['experimentalFeatures']]?: boolean } : {};
+  dependencies: T extends {
+    dependencies: Array<any>;
+  } ? T['dependencies'] : [];
+  optionalDependencies: T extends {
+    optionalDependencies: Array<any>;
+  } ? T['optionalDependencies'] : [];
+};
+export type TreeViewAnyPluginSignature = {
+  cache: any;
+  state: any;
+  instance: any;
+  params: any;
+  defaultizedParams: any;
+  dependencies: any;
+  optionalDependencies: any;
+  events: any;
+  contextValue: any;
+  slots: any;
+  slotProps: any;
+  models: any;
+  experimentalFeatures: any;
+  publicAPI: any;
+};
+type TreeViewRequiredPlugins<TSignature extends TreeViewAnyPluginSignature> = [...TreeViewCorePluginSignatures, ...TSignature['dependencies']];
+type PluginPropertyWithDependencies<TSignature extends TreeViewAnyPluginSignature, TProperty extends keyof TreeViewAnyPluginSignature> = TSignature[TProperty] & MergeSignaturesProperty<TreeViewRequiredPlugins<TSignature>, TProperty> & Partial<MergeSignaturesProperty<TSignature['optionalDependencies'], TProperty>>;
+export type TreeViewUsedParams<TSignature extends TreeViewAnyPluginSignature> = PluginPropertyWithDependencies<TSignature, 'params'>;
+export type TreeViewUsedDefaultizedParams<TSignature extends TreeViewAnyPluginSignature> = PluginPropertyWithDependencies<TSignature, 'defaultizedParams'>;
+export type TreeViewUsedInstance<TSignature extends TreeViewAnyPluginSignature> = PluginPropertyWithDependencies<TSignature, 'instance'> & {
+  /**
+   * Private property only defined in TypeScript to be able to access the plugin signature from the instance object.
+   */
+  $$signature: TSignature;
+};
+export type TreeViewUsedStore<TSignature extends TreeViewAnyPluginSignature> = TreeViewStore<[TSignature, ...TSignature['dependencies']]>;
+type TreeViewUsedExperimentalFeatures<TSignature extends TreeViewAnyPluginSignature> = TreeViewExperimentalFeatures<[TSignature, ...TSignature['dependencies']], TSignature['optionalDependencies']>;
+type RemoveSetValue<Models extends Record<string, TreeViewModel<any>>> = { [K in keyof Models]: Omit<Models[K], 'setValue'> };
+export type TreeViewUsedModels<TSignature extends TreeViewAnyPluginSignature> = TSignature['models'] & RemoveSetValue<MergeSignaturesProperty<TreeViewRequiredPlugins<TSignature>, 'models'>>;
+export type TreeViewUsedEvents<TSignature extends TreeViewAnyPluginSignature> = TSignature['events'] & MergeSignaturesProperty<TreeViewRequiredPlugins<TSignature>, 'events'>;
+export type TreeItemWrapper<TSignatures extends readonly TreeViewAnyPluginSignature[]> = (params: {
+  itemId: TreeViewItemId;
+  children: React.ReactNode;
+  instance: TreeViewInstance<TSignatures>;
+  idAttribute: string;
+}) => React.ReactNode;
+export type TreeRootWrapper = (params: {
+  children: React.ReactNode;
+}) => React.ReactNode;
+export type TreeViewPlugin<TSignature extends TreeViewAnyPluginSignature> = {
+  (options: TreeViewPluginOptions<TSignature>): TreeViewResponse<TSignature>;
+  getDefaultizedParams?: (options: {
+    params: TreeViewUsedParams<TSignature>;
+    experimentalFeatures: TreeViewUsedExperimentalFeatures<TSignature>;
+  }) => TSignature['defaultizedParams'];
+  getInitialState?: (params: TreeViewUsedDefaultizedParams<TSignature>) => TSignature['state'];
+  getInitialCache?: () => TSignature['cache'];
+  models?: TreeViewModelsInitializer<TSignature>;
+  params: Record<keyof TSignature['params'], true>;
+  itemPlugin?: TreeViewItemPlugin;
+  /**
+   * Render function used to add React wrappers around the TreeItem.
+   * @param {{ nodeId: TreeViewItemId; children: React.ReactNode; }} params The params of the item.
+   * @returns {React.ReactNode} The wrapped item.
+   */
+  wrapItem?: TreeItemWrapper<[TSignature, ...TSignature['dependencies']]>;
+  /**
+   * Render function used to add React wrappers around the TreeView.
+   * @param {{ children: React.ReactNode; }} params The params of the root.
+   * @returns {React.ReactNode} The wrapped root.
+   */
+  wrapRoot?: TreeRootWrapper;
+};
+export {};

package/esm/internals/models/plugin.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/models/treeView.d.ts

@@ -0,0 +1,32 @@
+import type { TreeViewAnyPluginSignature } from './plugin';
+import type { MergeSignaturesProperty } from './helpers';
+import type { TreeViewCorePluginSignatures } from '../corePlugins';
+export interface TreeViewItemMeta {
+  id: string;
+  idAttribute: string | undefined;
+  parentId: string | null;
+  expandable: boolean;
+  disabled: boolean;
+  /**
+   * Only defined for `<RichTreeView />` and `<RichTreeViewPro />`.
+   */
+  depth?: number;
+  /**
+   * Only defined for `<RichTreeView />` and `<RichTreeViewPro />`.
+   */
+  label?: string;
+}
+export interface TreeViewModel<TValue> {
+  name: string;
+  value: TValue;
+  setControlledValue: (value: TValue | ((prevValue: TValue) => TValue)) => void;
+}
+export type TreeViewInstance<TSignatures extends readonly TreeViewAnyPluginSignature[], TOptionalSignatures extends readonly TreeViewAnyPluginSignature[] = []> = MergeSignaturesProperty<[...TreeViewCorePluginSignatures, ...TSignatures], 'instance'> & Partial<MergeSignaturesProperty<TOptionalSignatures, 'instance'>>;
+export type TreeViewPublicAPI<TSignatures extends readonly TreeViewAnyPluginSignature[], TOptionalSignatures extends readonly TreeViewAnyPluginSignature[] = []> = MergeSignaturesProperty<[...TreeViewCorePluginSignatures, ...TSignatures], 'publicAPI'> & Partial<MergeSignaturesProperty<TOptionalSignatures, 'instance'>>;
+export type TreeViewExperimentalFeatures<TSignatures extends readonly TreeViewAnyPluginSignature[], TOptionalSignatures extends readonly TreeViewAnyPluginSignature[] = []> = MergeSignaturesProperty<[...TSignatures, ...TOptionalSignatures], 'experimentalFeatures'>;
+export type TreeViewStateCacheKey = {
+  id: number;
+};
+export type TreeViewState<TSignatures extends readonly TreeViewAnyPluginSignature[], TOptionalSignatures extends readonly TreeViewAnyPluginSignature[] = []> = MergeSignaturesProperty<[...TreeViewCorePluginSignatures, ...TSignatures], 'state'> & Partial<MergeSignaturesProperty<TOptionalSignatures, 'state'>> & {
+  cacheKey: TreeViewStateCacheKey;
+};

package/esm/internals/models/treeView.js

@@ -0,0 +1 @@
+export {};

package/esm/internals/plugins/useTreeViewExpansion/index.d.ts

@@ -0,0 +1,2 @@
+export { useTreeViewExpansion } from "./useTreeViewExpansion.js";
+export type { UseTreeViewExpansionSignature, UseTreeViewExpansionParameters, UseTreeViewExpansionDefaultizedParameters } from './useTreeViewExpansion.types';

package/esm/internals/plugins/useTreeViewExpansion/index.js

@@ -0,0 +1 @@
+export { useTreeViewExpansion } from "./useTreeViewExpansion.js";

package/esm/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.d.ts

@@ -0,0 +1,3 @@
+import { TreeViewPlugin } from "../../models/index.js";
+import { UseTreeViewExpansionSignature } from "./useTreeViewExpansion.types.js";
+export declare const useTreeViewExpansion: TreeViewPlugin<UseTreeViewExpansionSignature>;

package/esm/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js

@@ -0,0 +1,134 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import useEventCallback from '@mui/utils/useEventCallback';
+import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
+import { selectorIsItemExpandable, selectorIsItemExpanded } from "./useTreeViewExpansion.selectors.js";
+import { createExpandedItemsMap, getExpansionTrigger } from "./useTreeViewExpansion.utils.js";
+import { selectorItemMeta, selectorItemOrderedChildrenIds } from "../useTreeViewItems/useTreeViewItems.selectors.js";
+import { publishTreeViewEvent } from "../../utils/publishTreeViewEvent.js";
+export const useTreeViewExpansion = ({
+  instance,
+  store,
+  params,
+  models
+}) => {
+  useEnhancedEffect(() => {
+    store.update(prevState => _extends({}, prevState, {
+      expansion: _extends({}, prevState.expansion, {
+        expandedItemsMap: createExpandedItemsMap(models.expandedItems.value)
+      })
+    }));
+  }, [store, models.expandedItems.value]);
+  useEnhancedEffect(() => {
+    store.update(prevState => {
+      const newExpansionTrigger = getExpansionTrigger({
+        isItemEditable: params.isItemEditable,
+        expansionTrigger: params.expansionTrigger
+      });
+      if (prevState.expansion.expansionTrigger === newExpansionTrigger) {
+        return prevState;
+      }
+      return _extends({}, prevState, {
+        expansion: _extends({}, prevState.expansion, {
+          expansionTrigger: newExpansionTrigger
+        })
+      });
+    });
+  }, [store, params.isItemEditable, params.expansionTrigger]);
+  const setExpandedItems = (event, value) => {
+    params.onExpandedItemsChange?.(event, value);
+    models.expandedItems.setControlledValue(value);
+  };
+  const applyItemExpansion = useEventCallback(({
+    itemId,
+    event,
+    shouldBeExpanded
+  }) => {
+    let newExpanded;
+    if (shouldBeExpanded) {
+      newExpanded = [itemId].concat(models.expandedItems.value);
+    } else {
+      newExpanded = models.expandedItems.value.filter(id => id !== itemId);
+    }
+    if (params.onItemExpansionToggle) {
+      params.onItemExpansionToggle(event, itemId, shouldBeExpanded);
+    }
+    setExpandedItems(event, newExpanded);
+  });
+  const setItemExpansion = useEventCallback(({
+    itemId,
+    event = null,
+    shouldBeExpanded
+  }) => {
+    const isExpandedBefore = selectorIsItemExpanded(store.value, itemId);
+    const cleanShouldBeExpanded = shouldBeExpanded ?? !isExpandedBefore;
+    if (isExpandedBefore === cleanShouldBeExpanded) {
+      return;
+    }
+    const eventParameters = {
+      isExpansionPrevented: false,
+      shouldBeExpanded: cleanShouldBeExpanded,
+      event,
+      itemId
+    };
+    publishTreeViewEvent(instance, 'beforeItemToggleExpansion', eventParameters);
+    if (eventParameters.isExpansionPrevented) {
+      return;
+    }
+    instance.applyItemExpansion({
+      itemId,
+      event,
+      shouldBeExpanded: cleanShouldBeExpanded
+    });
+  });
+  const expandAllSiblings = (event, itemId) => {
+    const itemMeta = selectorItemMeta(store.value, itemId);
+    if (itemMeta == null) {
+      return;
+    }
+    const siblings = selectorItemOrderedChildrenIds(store.value, itemMeta.parentId);
+    const diff = siblings.filter(child => selectorIsItemExpandable(store.value, child) && !selectorIsItemExpanded(store.value, child));
+    const newExpanded = models.expandedItems.value.concat(diff);
+    if (diff.length > 0) {
+      if (params.onItemExpansionToggle) {
+        diff.forEach(newlyExpandedItemId => {
+          params.onItemExpansionToggle(event, newlyExpandedItemId, true);
+        });
+      }
+      setExpandedItems(event, newExpanded);
+    }
+  };
+  return {
+    publicAPI: {
+      setItemExpansion
+    },
+    instance: {
+      setItemExpansion,
+      applyItemExpansion,
+      expandAllSiblings
+    }
+  };
+};
+useTreeViewExpansion.models = {
+  expandedItems: {
+    getDefaultValue: params => params.defaultExpandedItems
+  }
+};
+const DEFAULT_EXPANDED_ITEMS = [];
+useTreeViewExpansion.getDefaultizedParams = ({
+  params
+}) => _extends({}, params, {
+  defaultExpandedItems: params.defaultExpandedItems ?? DEFAULT_EXPANDED_ITEMS
+});
+useTreeViewExpansion.getInitialState = params => ({
+  expansion: {
+    expandedItemsMap: createExpandedItemsMap(params.expandedItems === undefined ? params.defaultExpandedItems : params.expandedItems),
+    expansionTrigger: getExpansionTrigger(params)
+  }
+});
+useTreeViewExpansion.params = {
+  expandedItems: true,
+  defaultExpandedItems: true,
+  onExpandedItemsChange: true,
+  onItemExpansionToggle: true,
+  expansionTrigger: true
+};