@mui/x-tree-view 7.0.0-alpha.1 → 7.0.0-alpha.8

package/modern/TreeView/TreeView.js

@@ -1,15 +1,10 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
-import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["disabledItemsFocusable", "expanded", "defaultExpanded", "onNodeToggle", "onNodeFocus", "disableSelection", "defaultSelected", "selected", "multiSelect", "onNodeSelect", "id", "defaultCollapseIcon", "defaultEndIcon", "defaultExpandIcon", "defaultParentIcon", "children"];
 import * as React from 'react';
 import PropTypes from 'prop-types';
 import { styled, useThemeProps } from '@mui/material/styles';
 import composeClasses from '@mui/utils/composeClasses';
-import { useSlotProps } from '@mui/base/utils';
 import { getTreeViewUtilityClass } from './treeViewClasses';
-import { useTreeView } from '../internals/useTreeView';
-import { TreeViewProvider } from '../internals/TreeViewProvider';
-import { DEFAULT_TREE_VIEW_PLUGINS } from '../internals/plugins';
+import { SimpleTreeView, SimpleTreeViewRoot } from '../SimpleTreeView';
 import { jsx as _jsx } from "react/jsx-runtime";
 const useUtilityClasses = ownerState => {
   const {
@@ -20,17 +15,22 @@ const useUtilityClasses = ownerState => {
   };
   return composeClasses(slots, getTreeViewUtilityClass, classes);
 };
-const TreeViewRoot = styled('ul', {
+const TreeViewRoot = styled(SimpleTreeViewRoot, {
   name: 'MuiTreeView',
   slot: 'Root',
   overridesResolver: (props, styles) => styles.root
-})({
-  padding: 0,
-  margin: 0,
-  listStyle: 'none',
-  outline: 0
-});
+})({});
+let warnedOnce = false;
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI X: The TreeView component was renamed SimpleTreeView.', 'The component with the old naming will be removed in the version v8.0.0.', '', "You should use `import { SimpleTreeView } from '@mui/x-tree-view'`", "or `import { SimpleTreeView } from '@mui/x-tree-view/TreeView'`"].join('\n'));
+    warnedOnce = true;
+  }
+};
+
 /**
+ * This component has been deprecated in favor of the new `SimpleTreeView` component.
+ * You can have a look at how to migrate to the new component in the v7 [migration guide](https://next.mui.com/x/migration/migration-tree-view-v6/#use-simpletreeview-instead-of-treeview)
  *
  * Demos:
  *
@@ -39,72 +39,25 @@ const TreeViewRoot = styled('ul', {
  * API:
  *
  * - [TreeView API](https://mui.com/x/api/tree-view/tree-view/)
+ *
+ * @deprecated
  */
 const TreeView = /*#__PURE__*/React.forwardRef(function TreeView(inProps, ref) {
-  const themeProps = useThemeProps({
+  if (process.env.NODE_ENV !== 'production' && process.env.NODE_ENV !== 'test') {
+    warn();
+  }
+  const props = useThemeProps({
     props: inProps,
     name: 'MuiTreeView'
   });
-  const ownerState = themeProps;
-  const _ref = themeProps,
-    {
-      // Headless implementation
-      disabledItemsFocusable,
-      expanded,
-      defaultExpanded,
-      onNodeToggle,
-      onNodeFocus,
-      disableSelection,
-      defaultSelected,
-      selected,
-      multiSelect,
-      onNodeSelect,
-      id,
-      defaultCollapseIcon,
-      defaultEndIcon,
-      defaultExpandIcon,
-      defaultParentIcon,
-      // Component implementation
-      children
-    } = _ref,
-    other = _objectWithoutPropertiesLoose(_ref, _excluded);
-  const {
-    getRootProps,
-    contextValue
-  } = useTreeView({
-    disabledItemsFocusable,
-    expanded,
-    defaultExpanded,
-    onNodeToggle,
-    onNodeFocus,
-    disableSelection,
-    defaultSelected,
-    selected,
-    multiSelect,
-    onNodeSelect,
-    id,
-    defaultCollapseIcon,
-    defaultEndIcon,
-    defaultExpandIcon,
-    defaultParentIcon,
-    plugins: DEFAULT_TREE_VIEW_PLUGINS,
-    rootRef: ref
-  });
-  const classes = useUtilityClasses(themeProps);
-  const rootProps = useSlotProps({
-    elementType: TreeViewRoot,
-    externalSlotProps: {},
-    externalForwardedProps: other,
-    className: classes.root,
-    getSlotProps: getRootProps,
-    ownerState
-  });
-  return /*#__PURE__*/_jsx(TreeViewProvider, {
-    value: contextValue,
-    children: /*#__PURE__*/_jsx(TreeViewRoot, _extends({}, rootProps, {
-      children: children
-    }))
-  });
+  const classes = useUtilityClasses(props);
+  return /*#__PURE__*/_jsx(SimpleTreeView, _extends({}, props, {
+    ref: ref,
+    classes: classes,
+    slots: _extends({
+      root: TreeViewRoot
+    }, props.slots)
+  }));
 });
 process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
   // ----------------------------- Warning --------------------------------
@@ -137,7 +90,7 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
    * Used when the item's expansion is not controlled.
    * @default []
    */
-  defaultExpanded: PropTypes.arrayOf(PropTypes.string),
+  defaultExpandedNodes: PropTypes.arrayOf(PropTypes.string),
   /**
    * The default icon used to expand the node.
    */
@@ -152,7 +105,7 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    * @default []
    */
-  defaultSelected: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.arrayOf(PropTypes.string), PropTypes.string]),
+  defaultSelectedNodes: PropTypes.any,
   /**
    * If `true`, will allow focus on disabled items.
    * @default false
@@ -167,7 +120,25 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
    * Expanded node ids.
    * Used when the item's expansion is controlled.
    */
-  expanded: PropTypes.arrayOf(PropTypes.string),
+  expandedNodes: PropTypes.arrayOf(PropTypes.string),
+  /**
+   * Used to determine the string label for a given item.
+   *
+   * @template R
+   * @param {R} item The item to check.
+   * @returns {string} The id of the item.
+   * @default `(item) => item.id`
+   */
+  getItemId: PropTypes.func,
+  /**
+   * Used to determine the string label for a given item.
+   *
+   * @template R
+   * @param {R} item The item to check.
+   * @returns {string} The label of the item.
+   * @default `(item) => item.label`
+   */
+  getItemLabel: PropTypes.func,
   /**
    * This prop is used to help implement the accessibility logic.
    * If you don't provide this prop. It falls back to a randomly generated id.
@@ -178,6 +149,19 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
    * @default false
    */
   multiSelect: PropTypes.bool,
+  /**
+   * Callback fired when tree items are expanded/collapsed.
+   * @param {React.SyntheticEvent} event The event source of the callback.
+   * @param {array} nodeIds The ids of the expanded nodes.
+   */
+  onExpandedNodesChange: PropTypes.func,
+  /**
+   * Callback fired when a tree item is expanded or collapsed.
+   * @param {React.SyntheticEvent} event The event source of the callback.
+   * @param {array} nodeId The nodeId of the modified node.
+   * @param {array} isExpanded `true` if the node has just been expanded, `false` if it has just been collapsed.
+   */
+  onNodeExpansionToggle: PropTypes.func,
   /**
    * Callback fired when tree items are focused.
    * @param {React.SyntheticEvent} event The event source of the callback **Warning**: This is a generic event not a focus event.
@@ -186,23 +170,32 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
    */
   onNodeFocus: PropTypes.func,
   /**
-   * Callback fired when tree items are selected/unselected.
-   * @param {React.SyntheticEvent} event The event source of the callback
-   * @param {string[] | string} nodeIds Ids of the selected nodes. When `multiSelect` is true
-   * this is an array of strings; when false (default) a string.
+   * Callback fired when a tree item is selected or deselected.
+   * @param {React.SyntheticEvent} event The event source of the callback.
+   * @param {array} nodeId The nodeId of the modified node.
+   * @param {array} isSelected `true` if the node has just been selected, `false` if it has just been deselected.
    */
-  onNodeSelect: PropTypes.func,
+  onNodeSelectionToggle: PropTypes.func,
   /**
-   * Callback fired when tree items are expanded/collapsed.
-   * @param {React.SyntheticEvent} event The event source of the callback.
-   * @param {array} nodeIds The ids of the expanded nodes.
+   * Callback fired when tree items are selected/deselected.
+   * @param {React.SyntheticEvent} event The event source of the callback
+   * @param {string[] | string} nodeIds The ids of the selected nodes.
+   * When `multiSelect` is `true`, this is an array of strings; when false (default) a string.
    */
-  onNodeToggle: PropTypes.func,
+  onSelectedNodesChange: PropTypes.func,
   /**
    * Selected node ids. (Controlled)
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    */
-  selected: PropTypes.any,
+  selectedNodes: PropTypes.any,
+  /**
+   * The props used for each component slot.
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   */
+  slots: PropTypes.object,
   /**
    * The system prop that allows defining system overrides as well as additional CSS styles.
    */

package/modern/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-tree-view v7.0.0-alpha.1
+ * @mui/x-tree-view v7.0.0-alpha.8
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the
@@ -7,4 +7,7 @@
  */
 export * from './TreeItem';
 export * from './TreeView';
-export { unstable_resetCleanupTracking } from './internals/hooks/useInstanceEventHandler';
+export * from './SimpleTreeView';
+export * from './RichTreeView';
+export { unstable_resetCleanupTracking } from './internals/hooks/useInstanceEventHandler';
+export * from './models';

package/modern/internals/TreeViewProvider/TreeViewContext.js

@@ -1,21 +1,8 @@
 import * as React from 'react';
-export const DEFAULT_TREE_VIEW_CONTEXT_VALUE = {
-  instance: null,
-  multiSelect: false,
-  disabledItemsFocusable: false,
-  treeId: undefined,
-  icons: {
-    defaultCollapseIcon: null,
-    defaultExpandIcon: null,
-    defaultParentIcon: null,
-    defaultEndIcon: null
-  }
-};
-
 /**
  * @ignore - internal component.
  */
-export const TreeViewContext = /*#__PURE__*/React.createContext(DEFAULT_TREE_VIEW_CONTEXT_VALUE);
+export const TreeViewContext = /*#__PURE__*/React.createContext(null);
 if (process.env.NODE_ENV !== 'production') {
   TreeViewContext.displayName = 'TreeViewContext';
 }

package/modern/internals/TreeViewProvider/useTreeViewContext.js

@@ -1,3 +1,9 @@
 import * as React from 'react';
 import { TreeViewContext } from './TreeViewContext';
-export const useTreeViewContext = () => React.useContext(TreeViewContext);
+export const useTreeViewContext = () => {
+  const context = React.useContext(TreeViewContext);
+  if (context == null) {
+    throw new Error(['MUI X: Could not find the Tree View context.', 'It looks like you rendered your component outside of a SimpleTreeView or RichTreeView parent component.', 'This can also happen if you are bundling multiple versions of the Tree View.'].join('\n'));
+  }
+  return context;
+};

package/modern/internals/corePlugins/corePlugins.js

@@ -1,6 +1,6 @@
 import { useTreeViewInstanceEvents } from './useTreeViewInstanceEvents';
 /**
- * Internal plugins that creates the tools used by the other plugins.
+ * Internal plugins that create the tools used by the other plugins.
  * These plugins are used by the tree view components.
  */
 export const TREE_VIEW_CORE_PLUGINS = [useTreeViewInstanceEvents];

package/modern/internals/corePlugins/useTreeViewInstanceEvents/useTreeViewInstanceEvents.js

@@ -4,12 +4,6 @@ import { populateInstance } from '../../useTreeView/useTreeView.utils';
 const isSyntheticEvent = event => {
   return event.isPropagationStopped !== undefined;
 };
-
-/**
- * Plugin responsible for the registration of the nodes defined as JSX children of the TreeView.
- * When we will have both a SimpleTreeView using JSX children and a TreeView using a data prop,
- * this plugin will only be used by SimpleTreeView.
- */
 export const useTreeViewInstanceEvents = ({
   instance
 }) => {
@@ -32,4 +26,5 @@ export const useTreeViewInstanceEvents = ({
     $$publishEvent: publishEvent,
     $$subscribeEvent: subscribeEvent
   });
-};
+};
+useTreeViewInstanceEvents.params = {};

package/modern/internals/hooks/useLazyRef.js

@@ -0,0 +1,11 @@
+import * as React from 'react';
+const UNINITIALIZED = {};
+
+// See https://github.com/facebook/react/issues/14490 for when to use this.
+export function useLazyRef(init, initArg) {
+  const ref = React.useRef(UNINITIALIZED);
+  if (ref.current === UNINITIALIZED) {
+    ref.current = init(initArg);
+  }
+  return ref;
+}

package/modern/internals/hooks/useOnMount.js

@@ -0,0 +1,7 @@
+import * as React from 'react';
+const EMPTY = [];
+export function useOnMount(fn) {
+  /* eslint-disable react-hooks/exhaustive-deps */
+  React.useEffect(fn, EMPTY);
+  /* eslint-enable react-hooks/exhaustive-deps */
+}

package/modern/internals/hooks/useTimeout.js

@@ -0,0 +1,28 @@
+import { useLazyRef } from './useLazyRef';
+import { useOnMount } from './useOnMount';
+class Timeout {
+  constructor() {
+    this.currentId = 0;
+    this.clear = () => {
+      if (this.currentId !== 0) {
+        clearTimeout(this.currentId);
+        this.currentId = 0;
+      }
+    };
+    this.disposeEffect = () => {
+      return this.clear;
+    };
+  }
+  static create() {
+    return new Timeout();
+  }
+  start(delay, fn) {
+    this.clear();
+    this.currentId = setTimeout(fn, delay);
+  }
+}
+export function useTimeout() {
+  const timeout = useLazyRef(Timeout.create).current;
+  useOnMount(timeout.disposeEffect);
+  return timeout;
+}

package/modern/internals/models/MuiCancellableEvent.js

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

package/modern/internals/plugins/defaultPlugins.js

@@ -1,9 +1,10 @@
+import { useTreeViewId } from './useTreeViewId';
 import { useTreeViewNodes } from './useTreeViewNodes';
 import { useTreeViewExpansion } from './useTreeViewExpansion';
 import { useTreeViewSelection } from './useTreeViewSelection';
 import { useTreeViewFocus } from './useTreeViewFocus';
 import { useTreeViewKeyboardNavigation } from './useTreeViewKeyboardNavigation';
 import { useTreeViewContextValueBuilder } from './useTreeViewContextValueBuilder';
-export const DEFAULT_TREE_VIEW_PLUGINS = [useTreeViewNodes, useTreeViewExpansion, useTreeViewSelection, useTreeViewFocus, useTreeViewKeyboardNavigation, useTreeViewContextValueBuilder];
+export const DEFAULT_TREE_VIEW_PLUGINS = [useTreeViewId, useTreeViewNodes, useTreeViewExpansion, useTreeViewSelection, useTreeViewFocus, useTreeViewKeyboardNavigation, useTreeViewContextValueBuilder];
 
 // We can't infer this type from the plugin, otherwise we would lose the generics.

package/modern/internals/plugins/useTreeViewContextValueBuilder/useTreeViewContextValueBuilder.js

@@ -1,17 +1,19 @@
-import useId from '@mui/utils/useId';
 export const useTreeViewContextValueBuilder = ({
   instance,
   params
 }) => {
-  const treeId = useId(params.id);
   return {
-    getRootProps: () => ({
-      id: treeId
-    }),
     contextValue: {
-      treeId,
       instance: instance,
       multiSelect: params.multiSelect,
+      runItemPlugins: ({
+        props,
+        ref
+      }) => ({
+        props,
+        ref,
+        wrapItem: children => children
+      }),
       disabledItemsFocusable: params.disabledItemsFocusable,
       icons: {
         defaultCollapseIcon: params.defaultCollapseIcon,
@@ -21,4 +23,10 @@ export const useTreeViewContextValueBuilder = ({
       }
     }
   };
+};
+useTreeViewContextValueBuilder.params = {
+  defaultCollapseIcon: true,
+  defaultEndIcon: true,
+  defaultExpandIcon: true,
+  defaultParentIcon: true
 };

package/modern/internals/plugins/useTreeViewExpansion/useTreeViewExpansion.js

@@ -8,34 +8,43 @@ export const useTreeViewExpansion = ({
   models
 }) => {
   const isNodeExpanded = React.useCallback(nodeId => {
-    return Array.isArray(models.expanded.value) ? models.expanded.value.indexOf(nodeId) !== -1 : false;
-  }, [models.expanded.value]);
+    return Array.isArray(models.expandedNodes.value) ? models.expandedNodes.value.indexOf(nodeId) !== -1 : false;
+  }, [models.expandedNodes.value]);
   const isNodeExpandable = React.useCallback(nodeId => !!instance.getNode(nodeId)?.expandable, [instance]);
   const toggleNodeExpansion = useEventCallback((event, nodeId) => {
     if (nodeId == null) {
       return;
     }
+    const isExpandedBefore = models.expandedNodes.value.indexOf(nodeId) !== -1;
     let newExpanded;
-    if (models.expanded.value.indexOf(nodeId) !== -1) {
-      newExpanded = models.expanded.value.filter(id => id !== nodeId);
+    if (isExpandedBefore) {
+      newExpanded = models.expandedNodes.value.filter(id => id !== nodeId);
     } else {
-      newExpanded = [nodeId].concat(models.expanded.value);
+      newExpanded = [nodeId].concat(models.expandedNodes.value);
     }
-    if (params.onNodeToggle) {
-      params.onNodeToggle(event, newExpanded);
+    if (params.onNodeExpansionToggle) {
+      params.onNodeExpansionToggle(event, nodeId, !isExpandedBefore);
     }
-    models.expanded.setValue(newExpanded);
+    if (params.onExpandedNodesChange) {
+      params.onExpandedNodesChange(event, newExpanded);
+    }
+    models.expandedNodes.setValue(newExpanded);
   });
   const expandAllSiblings = (event, nodeId) => {
     const node = instance.getNode(nodeId);
     const siblings = instance.getChildrenIds(node.parentId);
     const diff = siblings.filter(child => instance.isNodeExpandable(child) && !instance.isNodeExpanded(child));
-    const newExpanded = models.expanded.value.concat(diff);
+    const newExpanded = models.expandedNodes.value.concat(diff);
     if (diff.length > 0) {
-      models.expanded.setValue(newExpanded);
-      if (params.onNodeToggle) {
-        params.onNodeToggle(event, newExpanded);
+      if (params.onNodeExpansionToggle) {
+        diff.forEach(newlyExpandedNodeId => {
+          params.onNodeExpansionToggle(event, newlyExpandedNodeId, true);
+        });
+      }
+      if (params.onExpandedNodesChange) {
+        params.onExpandedNodesChange(event, newExpanded);
       }
+      models.expandedNodes.setValue(newExpanded);
     }
   };
   populateInstance(instance, {
@@ -46,12 +55,18 @@ export const useTreeViewExpansion = ({
   });
 };
 useTreeViewExpansion.models = {
-  expanded: {
-    controlledProp: 'expanded',
-    defaultProp: 'defaultExpanded'
+  expandedNodes: {
+    controlledProp: 'expandedNodes',
+    defaultProp: 'defaultExpandedNodes'
   }
 };
-const DEFAULT_EXPANDED = [];
+const DEFAULT_EXPANDED_NODES = [];
 useTreeViewExpansion.getDefaultizedParams = params => _extends({}, params, {
-  defaultExpanded: params.defaultExpanded ?? DEFAULT_EXPANDED
-});
+  defaultExpandedNodes: params.defaultExpandedNodes ?? DEFAULT_EXPANDED_NODES
+});
+useTreeViewExpansion.params = {
+  expandedNodes: true,
+  defaultExpandedNodes: true,
+  onExpandedNodesChange: true,
+  onNodeExpansionToggle: true
+};

package/modern/internals/plugins/useTreeViewFocus/useTreeViewFocus.js

@@ -27,9 +27,15 @@ export const useTreeViewFocus = ({
       }
     }
   });
+  const focusRoot = useEventCallback(() => {
+    rootRef.current?.focus({
+      preventScroll: true
+    });
+  });
   populateInstance(instance, {
     isNodeFocused,
-    focusNode
+    focusNode,
+    focusRoot
   });
   useInstanceEventHandler(instance, 'removeNode', ({
     id
@@ -51,10 +57,10 @@ export const useTreeViewFocus = ({
         return node && (node.parentId == null || instance.isNodeExpanded(node.parentId));
       };
       let nodeToFocusId;
-      if (Array.isArray(models.selected.value)) {
-        nodeToFocusId = models.selected.value.find(isNodeVisible);
-      } else if (models.selected.value != null && isNodeVisible(models.selected.value)) {
-        nodeToFocusId = models.selected.value;
+      if (Array.isArray(models.selectedNodes.value)) {
+        nodeToFocusId = models.selectedNodes.value.find(isNodeVisible);
+      } else if (models.selectedNodes.value != null && isNodeVisible(models.selectedNodes.value)) {
+        nodeToFocusId = models.selectedNodes.value;
       }
       if (nodeToFocusId == null) {
         nodeToFocusId = instance.getNavigableChildrenIds(null)[0];
@@ -67,7 +73,7 @@ export const useTreeViewFocus = ({
     setFocusedNodeId(null);
   };
   const focusedNode = instance.getNode(state.focusedNodeId);
-  const activeDescendant = focusedNode ? focusedNode.idAttribute : null;
+  const activeDescendant = focusedNode ? instance.getTreeItemId(focusedNode.id, focusedNode.idAttribute) : null;
   return {
     getRootProps: otherHandlers => ({
       onFocus: createHandleFocus(otherHandlers),
@@ -81,4 +87,7 @@ useTreeViewFocus.getInitialState = () => ({
 });
 useTreeViewFocus.getDefaultizedParams = params => _extends({}, params, {
   disabledItemsFocusable: params.disabledItemsFocusable ?? false
-});
+});
+useTreeViewFocus.params = {
+  onNodeFocus: true
+};

package/modern/internals/plugins/useTreeViewId/index.js

@@ -0,0 +1 @@
+export { useTreeViewId } from './useTreeViewId';

package/modern/internals/plugins/useTreeViewId/useTreeViewId.js

@@ -0,0 +1,21 @@
+import * as React from 'react';
+import useId from '@mui/utils/useId';
+import { populateInstance } from '../../useTreeView/useTreeView.utils';
+export const useTreeViewId = ({
+  instance,
+  params
+}) => {
+  const treeId = useId(params.id);
+  const getTreeItemId = React.useCallback((nodeId, idAttribute) => idAttribute ?? `${treeId}-${nodeId}`, [treeId]);
+  populateInstance(instance, {
+    getTreeItemId
+  });
+  return {
+    getRootProps: () => ({
+      id: treeId
+    })
+  };
+};
+useTreeViewId.params = {
+  id: true
+};

package/modern/internals/plugins/useTreeViewId/useTreeViewId.types.js

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

package/modern/internals/plugins/useTreeViewJSXNodes/index.js

@@ -0,0 +1 @@
+export { useTreeViewJSXNodes } from './useTreeViewJSXNodes';