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

package/modern/SimpleTreeView/SimpleTreeView.js

@@ -0,0 +1,234 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+const _excluded = ["slots", "slotProps"];
+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 { getSimpleTreeViewUtilityClass } from './simpleTreeViewClasses';
+import { useTreeView } from '../internals/useTreeView';
+import { TreeViewProvider } from '../internals/TreeViewProvider';
+import { SIMPLE_TREE_VIEW_PLUGINS } from './SimpleTreeView.plugins';
+import { buildWarning } from '../internals/utils/warning';
+import { extractPluginParamsFromProps } from '../internals/utils/extractPluginParamsFromProps';
+import { jsx as _jsx } from "react/jsx-runtime";
+const useUtilityClasses = ownerState => {
+  const {
+    classes
+  } = ownerState;
+  const slots = {
+    root: ['root']
+  };
+  return composeClasses(slots, getSimpleTreeViewUtilityClass, classes);
+};
+export const SimpleTreeViewRoot = styled('ul', {
+  name: 'MuiSimpleTreeView',
+  slot: 'Root',
+  overridesResolver: (props, styles) => styles.root
+})({
+  padding: 0,
+  margin: 0,
+  listStyle: 'none',
+  outline: 0
+});
+const EMPTY_ITEMS = [];
+const itemsPropWarning = buildWarning(['MUI X: The `SimpleTreeView` component does not support the `items` prop.', 'If you want to add items, you need to pass them as JSX children.', 'Check the documentation for more details: https://next.mui.com/x/react-tree-view/simple-tree-view/items/']);
+
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/x/react-tree-view/)
+ *
+ * API:
+ *
+ * - [SimpleTreeView API](https://mui.com/x/api/tree-view/simple-tree-view/)
+ */
+const SimpleTreeView = /*#__PURE__*/React.forwardRef(function SimpleTreeView(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiSimpleTreeView'
+  });
+  const ownerState = props;
+  if (process.env.NODE_ENV !== 'production') {
+    if (props.items != null) {
+      itemsPropWarning();
+    }
+  }
+  const _extractPluginParamsF = extractPluginParamsFromProps({
+      props: _extends({}, props, {
+        items: EMPTY_ITEMS
+      }),
+      plugins: SIMPLE_TREE_VIEW_PLUGINS,
+      rootRef: ref
+    }),
+    {
+      pluginParams,
+      otherProps: {
+        slots
+      }
+    } = _extractPluginParamsF,
+    otherProps = _objectWithoutPropertiesLoose(_extractPluginParamsF.otherProps, _excluded);
+  const {
+    getRootProps,
+    contextValue
+  } = useTreeView(pluginParams);
+  const classes = useUtilityClasses(props);
+  const Root = slots?.root ?? SimpleTreeViewRoot;
+  const rootProps = useSlotProps({
+    elementType: Root,
+    externalSlotProps: {},
+    externalForwardedProps: otherProps,
+    className: classes.root,
+    getSlotProps: getRootProps,
+    ownerState
+  });
+  return /*#__PURE__*/_jsx(TreeViewProvider, {
+    value: contextValue,
+    children: /*#__PURE__*/_jsx(Root, _extends({}, rootProps))
+  });
+});
+process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * The content of the component.
+   */
+  children: PropTypes.node,
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object,
+  /**
+   * className applied to the root element.
+   */
+  className: PropTypes.string,
+  /**
+   * The default icon used to collapse the node.
+   */
+  defaultCollapseIcon: PropTypes.node,
+  /**
+   * The default icon displayed next to a end node. This is applied to all
+   * tree nodes and can be overridden by the TreeItem `icon` prop.
+   */
+  defaultEndIcon: PropTypes.node,
+  /**
+   * Expanded node ids.
+   * Used when the item's expansion is not controlled.
+   * @default []
+   */
+  defaultExpandedNodes: PropTypes.arrayOf(PropTypes.string),
+  /**
+   * The default icon used to expand the node.
+   */
+  defaultExpandIcon: PropTypes.node,
+  /**
+   * The default icon displayed next to a parent node. This is applied to all
+   * parent nodes and can be overridden by the TreeItem `icon` prop.
+   */
+  defaultParentIcon: PropTypes.node,
+  /**
+   * Selected node ids. (Uncontrolled)
+   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
+   * @default []
+   */
+  defaultSelectedNodes: PropTypes.any,
+  /**
+   * If `true`, will allow focus on disabled items.
+   * @default false
+   */
+  disabledItemsFocusable: PropTypes.bool,
+  /**
+   * If `true` selection is disabled.
+   * @default false
+   */
+  disableSelection: PropTypes.bool,
+  /**
+   * Expanded node ids.
+   * Used when the item's expansion is controlled.
+   */
+  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.
+   */
+  id: PropTypes.string,
+  /**
+   * If true `ctrl` and `shift` will trigger multiselect.
+   * @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.
+   * @param {string} nodeId The id of the node focused.
+   * @param {string} value of the focused node.
+   */
+  onNodeFocus: PropTypes.func,
+  /**
+   * 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.
+   */
+  onNodeSelectionToggle: PropTypes.func,
+  /**
+   * 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.
+   */
+  onSelectedNodesChange: PropTypes.func,
+  /**
+   * Selected node ids. (Controlled)
+   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
+   */
+  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.
+   */
+  sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object])
+} : void 0;
+export { SimpleTreeView };

package/modern/SimpleTreeView/SimpleTreeView.plugins.js

@@ -0,0 +1,5 @@
+import { DEFAULT_TREE_VIEW_PLUGINS } from '../internals/plugins/defaultPlugins';
+import { useTreeViewJSXNodes } from '../internals/plugins/useTreeViewJSXNodes';
+export const SIMPLE_TREE_VIEW_PLUGINS = [...DEFAULT_TREE_VIEW_PLUGINS, useTreeViewJSXNodes];
+
+// We can't infer this type from the plugin, otherwise we would lose the generics.

package/modern/SimpleTreeView/SimpleTreeView.types.js

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

package/modern/SimpleTreeView/index.js

@@ -0,0 +1,3 @@
+export * from './SimpleTreeView';
+export * from './simpleTreeViewClasses';
+export {};

package/modern/SimpleTreeView/simpleTreeViewClasses.js

@@ -0,0 +1,6 @@
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+export function getSimpleTreeViewUtilityClass(slot) {
+  return generateUtilityClass('MuiSimpleTreeView', slot);
+}
+export const simpleTreeViewClasses = generateUtilityClasses('MuiSimpleTreeView', ['root']);

package/modern/TreeItem/TreeItem.js

@@ -1,17 +1,14 @@
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 import _extends from "@babel/runtime/helpers/esm/extends";
-const _excluded = ["children", "className", "collapseIcon", "ContentComponent", "ContentProps", "endIcon", "expandIcon", "disabled", "icon", "id", "label", "nodeId", "onClick", "onMouseDown", "TransitionComponent", "TransitionProps"];
+const _excluded = ["children", "className", "collapseIcon", "ContentComponent", "ContentProps", "endIcon", "expandIcon", "icon", "nodeId", "id", "label", "onClick", "onMouseDown", "TransitionComponent", "TransitionProps"];
 import * as React from 'react';
 import PropTypes from 'prop-types';
 import clsx from 'clsx';
 import Collapse from '@mui/material/Collapse';
 import { alpha, styled, useThemeProps } from '@mui/material/styles';
-import ownerDocument from '@mui/utils/ownerDocument';
-import useForkRef from '@mui/utils/useForkRef';
 import unsupportedProp from '@mui/utils/unsupportedProp';
 import elementTypeAcceptingRef from '@mui/utils/elementTypeAcceptingRef';
 import { unstable_composeClasses as composeClasses } from '@mui/base';
-import { DescendantProvider, useDescendant } from '../internals/TreeViewProvider/DescendantProvider';
 import { TreeItemContent } from './TreeItemContent';
 import { treeItemClasses, getTreeItemUtilityClass } from './treeItemClasses';
 import { useTreeViewContext } from '../internals/TreeViewProvider/useTreeViewContext';
@@ -132,11 +129,26 @@ const TreeItemGroup = styled(Collapse, {
  *
  * - [TreeItem API](https://mui.com/x/api/tree-view/tree-item/)
  */
-export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps, ref) {
-  const props = useThemeProps({
+export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps, inRef) {
+  const {
+    icons: contextIcons,
+    runItemPlugins,
+    multiSelect,
+    disabledItemsFocusable,
+    instance
+  } = useTreeViewContext();
+  const inPropsWithTheme = useThemeProps({
     props: inProps,
     name: 'MuiTreeItem'
   });
+  const {
+    props,
+    ref,
+    wrapItem
+  } = runItemPlugins({
+    props: inPropsWithTheme,
+    ref: inRef
+  });
   const {
       children,
       className,
@@ -145,46 +157,21 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
       ContentProps,
       endIcon,
       expandIcon,
-      disabled: disabledProp,
       icon,
-      id: idProp,
-      label,
       nodeId,
+      id,
+      label,
       onClick,
       onMouseDown,
       TransitionComponent = Collapse,
       TransitionProps
     } = props,
     other = _objectWithoutPropertiesLoose(props, _excluded);
-  const {
-    icons: contextIcons,
-    multiSelect,
-    disabledItemsFocusable,
-    treeId,
-    instance
-  } = useTreeViewContext();
-  let id;
-  if (idProp != null) {
-    id = idProp;
-  } else if (treeId && nodeId) {
-    id = `${treeId}-${nodeId}`;
-  }
-  const [treeItemElement, setTreeItemElement] = React.useState(null);
-  const contentRef = React.useRef(null);
-  const handleRef = useForkRef(setTreeItemElement, ref);
-  const descendant = React.useMemo(() => ({
-    element: treeItemElement,
-    id: nodeId
-  }), [nodeId, treeItemElement]);
-  const {
-    index,
-    parentId
-  } = useDescendant(descendant);
   const expandable = Boolean(Array.isArray(children) ? children.length : children);
-  const expanded = instance ? instance.isNodeExpanded(nodeId) : false;
-  const focused = instance ? instance.isNodeFocused(nodeId) : false;
-  const selected = instance ? instance.isNodeSelected(nodeId) : false;
-  const disabled = instance ? instance.isNodeDisabled(nodeId) : false;
+  const expanded = instance.isNodeExpanded(nodeId);
+  const focused = instance.isNodeFocused(nodeId);
+  const selected = instance.isNodeSelected(nodeId);
+  const disabled = instance.isNodeDisabled(nodeId);
   const ownerState = _extends({}, props, {
     expanded,
     focused,
@@ -206,27 +193,6 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
   } else {
     displayIcon = endIcon || contextIcons.defaultEndIcon;
   }
-  React.useEffect(() => {
-    // On the first render a node's index will be -1. We want to wait for the real index.
-    if (instance && index !== -1) {
-      instance.updateNode({
-        id: nodeId,
-        idAttribute: id,
-        index,
-        parentId,
-        expandable,
-        disabled: disabledProp
-      });
-      return () => instance.removeNode(nodeId);
-    }
-    return undefined;
-  }, [instance, parentId, index, nodeId, expandable, disabledProp, id]);
-  React.useEffect(() => {
-    if (instance && label) {
-      return instance.mapFirstChar(nodeId, (contentRef.current?.textContent ?? '').substring(0, 1).toLowerCase());
-    }
-    return undefined;
-  }, [instance, nodeId, label]);
   let ariaSelected;
   if (multiSelect) {
     ariaSelected = selected;
@@ -242,36 +208,28 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
   function handleFocus(event) {
     // DOM focus stays on the tree which manages focus with aria-activedescendant
     if (event.target === event.currentTarget) {
-      let rootElement;
-      if (typeof event.target.getRootNode === 'function') {
-        rootElement = event.target.getRootNode();
-      } else {
-        rootElement = ownerDocument(event.target);
-      }
-      rootElement.getElementById(treeId).focus({
-        preventScroll: true
-      });
+      instance.focusRoot();
     }
-    const unfocusable = !disabledItemsFocusable && disabled;
-    if (instance && !focused && event.currentTarget === event.target && !unfocusable) {
+    const canBeFocused = !disabled || disabledItemsFocusable;
+    if (!focused && canBeFocused && event.currentTarget === event.target) {
       instance.focusNode(event, nodeId);
     }
   }
-  return /*#__PURE__*/_jsxs(TreeItemRoot, _extends({
+  const idAttribute = instance.getTreeItemId(nodeId, id);
+  const item = /*#__PURE__*/_jsxs(TreeItemRoot, _extends({
     className: clsx(classes.root, className),
     role: "treeitem",
     "aria-expanded": expandable ? expanded : undefined,
     "aria-selected": ariaSelected,
     "aria-disabled": disabled || undefined,
-    id: id,
+    id: idAttribute,
     tabIndex: -1
   }, other, {
     ownerState: ownerState,
     onFocus: handleFocus,
-    ref: handleRef,
+    ref: ref,
     children: [/*#__PURE__*/_jsx(StyledTreeItemContent, _extends({
       as: ContentComponent,
-      ref: contentRef,
       classes: {
         root: classes.content,
         expanded: classes.expanded,
@@ -289,22 +247,20 @@ export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps,
       expansionIcon: expansionIcon,
       displayIcon: displayIcon,
       ownerState: ownerState
-    }, ContentProps)), children && /*#__PURE__*/_jsx(DescendantProvider, {
-      id: nodeId,
-      children: /*#__PURE__*/_jsx(TreeItemGroup, _extends({
-        as: TransitionComponent,
-        unmountOnExit: true,
-        className: classes.group,
-        in: expanded,
-        component: "ul",
-        role: "group"
-      }, TransitionProps, {
-        children: children
-      }))
-    })]
+    }, ContentProps)), children && /*#__PURE__*/_jsx(TreeItemGroup, _extends({
+      as: TransitionComponent,
+      unmountOnExit: true,
+      className: classes.group,
+      in: expanded,
+      component: "ul",
+      role: "group"
+    }, TransitionProps, {
+      children: children
+    }))]
   }));
+  return wrapItem(item);
 });
-process.env.NODE_ENV !== "production" ? TreeItem.propTypes = {
+TreeItem.propTypes = {
   // ----------------------------- Warning --------------------------------
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "yarn proptypes"  |
@@ -379,4 +335,4 @@ process.env.NODE_ENV !== "production" ? TreeItem.propTypes = {
    * By default, the element is based on this [`Transition`](http://reactcommunity.org/react-transition-group/transition/) component.
    */
   TransitionProps: PropTypes.object
-} : void 0;
+};

package/modern/TreeItem/index.js

@@ -1,4 +1,4 @@
-export * from './TreeItem';
-export * from './useTreeItem';
+export { TreeItem } from './TreeItem';
 export * from './treeItemClasses';
+export * from './useTreeItem';
 export { TreeItemContent } from './TreeItemContent';

package/modern/TreeItem/useTreeItem.js

@@ -4,11 +4,11 @@ export function useTreeItem(nodeId) {
     instance,
     multiSelect
   } = useTreeViewContext();
-  const expandable = instance ? instance.isNodeExpandable(nodeId) : false;
-  const expanded = instance ? instance.isNodeExpanded(nodeId) : false;
-  const focused = instance ? instance.isNodeFocused(nodeId) : false;
-  const selected = instance ? instance.isNodeSelected(nodeId) : false;
-  const disabled = instance ? instance.isNodeDisabled(nodeId) : false;
+  const expandable = instance.isNodeExpandable(nodeId);
+  const expanded = instance.isNodeExpanded(nodeId);
+  const focused = instance.isNodeFocused(nodeId);
+  const selected = instance.isNodeSelected(nodeId);
+  const disabled = instance.isNodeDisabled(nodeId);
   const handleExpansion = event => {
     if (instance && !disabled) {
       if (!focused) {