@mui/x-tree-view 6.0.0-alpha.0

package/legacy/TreeView/TreeView.types.js

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

package/legacy/TreeView/TreeViewContext.js

@@ -0,0 +1,41 @@
+import * as React from 'react';
+/**
+ * @ignore - internal component.
+ */
+export var TreeViewContext = /*#__PURE__*/React.createContext({
+  registerNode: function registerNode() {},
+  unregisterNode: function unregisterNode() {},
+  isFocused: function isFocused() {
+    return false;
+  },
+  isSelected: function isSelected() {
+    return false;
+  },
+  isExpanded: function isExpanded() {
+    return false;
+  },
+  isExpandable: function isExpandable() {
+    return false;
+  },
+  isDisabled: function isDisabled() {
+    return false;
+  },
+  mapFirstChar: function mapFirstChar() {},
+  unMapFirstChar: function unMapFirstChar() {},
+  focus: function focus() {},
+  toggleExpansion: function toggleExpansion() {},
+  selectNode: function selectNode() {},
+  selectRange: function selectRange() {},
+  multiSelect: false,
+  disabledItemsFocusable: false,
+  treeId: undefined,
+  icons: {
+    defaultCollapseIcon: null,
+    defaultExpandIcon: null,
+    defaultParentIcon: null,
+    defaultEndIcon: null
+  }
+});
+if (process.env.NODE_ENV !== 'production') {
+  TreeViewContext.displayName = 'TreeViewContext';
+}

package/legacy/TreeView/descendants.js

@@ -0,0 +1,199 @@
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
+var _excluded = ["element"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import useEnhancedEffect from '@mui/utils/useEnhancedEffect';
+
+/** Credit: https://github.com/reach/reach-ui/blob/86a046f54d53b6420e392b3fa56dd991d9d4e458/packages/descendants/README.md
+ *  Modified slightly to suit our purposes.
+ */
+
+// To replace with .findIndex() once we stop IE11 support.
+import { jsx as _jsx } from "react/jsx-runtime";
+function findIndex(array, comp) {
+  for (var i = 0; i < array.length; i += 1) {
+    if (comp(array[i])) {
+      return i;
+    }
+  }
+  return -1;
+}
+function binaryFindElement(array, element) {
+  var start = 0;
+  var end = array.length - 1;
+  while (start <= end) {
+    var middle = Math.floor((start + end) / 2);
+    if (array[middle].element === element) {
+      return middle;
+    }
+
+    // eslint-disable-next-line no-bitwise
+    if (array[middle].element.compareDocumentPosition(element) & Node.DOCUMENT_POSITION_PRECEDING) {
+      end = middle - 1;
+    } else {
+      start = middle + 1;
+    }
+  }
+  return start;
+}
+var DescendantContext = /*#__PURE__*/React.createContext({});
+if (process.env.NODE_ENV !== 'production') {
+  DescendantContext.displayName = 'DescendantContext';
+}
+function usePrevious(value) {
+  var ref = React.useRef(null);
+  React.useEffect(function () {
+    ref.current = value;
+  }, [value]);
+  return ref.current;
+}
+var noop = function noop() {};
+
+/**
+ * This hook registers our descendant by passing it into an array. We can then
+ * search that array by to find its index when registering it in the component.
+ * We use this for focus management, keyboard navigation, and typeahead
+ * functionality for some components.
+ *
+ * The hook accepts the element node
+ *
+ * Our main goals with this are:
+ *   1) maximum composability,
+ *   2) minimal API friction
+ *   3) SSR compatibility*
+ *   4) concurrent safe
+ *   5) index always up-to-date with the tree despite changes
+ *   6) works with memoization of any component in the tree (hopefully)
+ *
+ * * As for SSR, the good news is that we don't actually need the index on the
+ * server for most use-cases, as we are only using it to determine the order of
+ * composed descendants for keyboard navigation.
+ */
+export function useDescendant(descendant) {
+  var _React$useState = React.useState(),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    forceUpdate = _React$useState2[1];
+  var _React$useContext = React.useContext(DescendantContext),
+    _React$useContext$reg = _React$useContext.registerDescendant,
+    registerDescendant = _React$useContext$reg === void 0 ? noop : _React$useContext$reg,
+    _React$useContext$unr = _React$useContext.unregisterDescendant,
+    unregisterDescendant = _React$useContext$unr === void 0 ? noop : _React$useContext$unr,
+    _React$useContext$des = _React$useContext.descendants,
+    descendants = _React$useContext$des === void 0 ? [] : _React$useContext$des,
+    _React$useContext$par = _React$useContext.parentId,
+    parentId = _React$useContext$par === void 0 ? null : _React$useContext$par;
+
+  // This will initially return -1 because we haven't registered the descendant
+  // on the first render. After we register, this will then return the correct
+  // index on the following render, and we will re-register descendants
+  // so that everything is up-to-date before the user interacts with a
+  // collection.
+  var index = findIndex(descendants, function (item) {
+    return item.element === descendant.element;
+  });
+  var previousDescendants = usePrevious(descendants);
+
+  // We also need to re-register descendants any time ANY of the other
+  // descendants have changed. My brain was melting when I wrote this and it
+  // feels a little off, but checking in render and using the result in the
+  // effect's dependency array works well enough.
+  var someDescendantsHaveChanged = descendants.some(function (newDescendant, position) {
+    return previousDescendants && previousDescendants[position] && previousDescendants[position].element !== newDescendant.element;
+  });
+
+  // Prevent any flashing
+  useEnhancedEffect(function () {
+    if (descendant.element) {
+      registerDescendant(_extends({}, descendant, {
+        index: index
+      }));
+      return function () {
+        unregisterDescendant(descendant.element);
+      };
+    }
+    forceUpdate({});
+    return undefined;
+  }, [registerDescendant, unregisterDescendant, index, someDescendantsHaveChanged, descendant]);
+  return {
+    parentId: parentId,
+    index: index
+  };
+}
+export function DescendantProvider(props) {
+  var children = props.children,
+    id = props.id;
+  var _React$useState3 = React.useState([]),
+    _React$useState4 = _slicedToArray(_React$useState3, 2),
+    items = _React$useState4[0],
+    set = _React$useState4[1];
+  var registerDescendant = React.useCallback(function (_ref) {
+    var element = _ref.element,
+      other = _objectWithoutProperties(_ref, _excluded);
+    set(function (oldItems) {
+      if (oldItems.length === 0) {
+        // If there are no items, register at index 0 and bail.
+        return [_extends({}, other, {
+          element: element,
+          index: 0
+        })];
+      }
+      var index = binaryFindElement(oldItems, element);
+      var newItems;
+      if (oldItems[index] && oldItems[index].element === element) {
+        // If the element is already registered, just use the same array
+        newItems = oldItems;
+      } else {
+        // When registering a descendant, we need to make sure we insert in
+        // into the array in the same order that it appears in the DOM. So as
+        // new descendants are added or maybe some are removed, we always know
+        // that the array is up-to-date and correct.
+        //
+        // So here we look at our registered descendants and see if the new
+        // element we are adding appears earlier than an existing descendant's
+        // DOM node via `node.compareDocumentPosition`. If it does, we insert
+        // the new element at this index. Because `registerDescendant` will be
+        // called in an effect every time the descendants state value changes,
+        // we should be sure that this index is accurate when descendent
+        // elements come or go from our component.
+
+        var newItem = _extends({}, other, {
+          element: element,
+          index: index
+        });
+
+        // If an index is not found we will push the element to the end.
+        newItems = oldItems.slice();
+        newItems.splice(index, 0, newItem);
+      }
+      newItems.forEach(function (item, position) {
+        item.index = position;
+      });
+      return newItems;
+    });
+  }, []);
+  var unregisterDescendant = React.useCallback(function (element) {
+    set(function (oldItems) {
+      return oldItems.filter(function (item) {
+        return element !== item.element;
+      });
+    });
+  }, []);
+  var value = React.useMemo(function () {
+    return {
+      descendants: items,
+      registerDescendant: registerDescendant,
+      unregisterDescendant: unregisterDescendant,
+      parentId: id
+    };
+  }, [items, registerDescendant, unregisterDescendant, id]);
+  return /*#__PURE__*/_jsx(DescendantContext.Provider, {
+    value: value,
+    children: children
+  });
+}
+process.env.NODE_ENV !== "production" ? DescendantProvider.propTypes = {
+  children: PropTypes.node,
+  id: PropTypes.string
+} : void 0;

package/legacy/TreeView/index.js

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

package/legacy/TreeView/treeViewClasses.js

@@ -0,0 +1,6 @@
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+export function getTreeViewUtilityClass(slot) {
+  return generateUtilityClass('MuiTreeView', slot);
+}
+export var treeViewClasses = generateUtilityClasses('MuiTreeView', ['root']);

package/legacy/index.js

@@ -0,0 +1,9 @@
+/**
+ * @mui/x-tree-view v6.0.0-alpha.0
+ *
+ * @license MIT
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export * from './TreeItem';
+export * from './TreeView';

package/legacy/internals/models.js

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

package/modern/TreeItem/TreeItem.js

@@ -0,0 +1,391 @@
+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"];
+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 { TreeViewContext } from '../TreeView/TreeViewContext';
+import { DescendantProvider, useDescendant } from '../TreeView/descendants';
+import { TreeItemContent } from './TreeItemContent';
+import { treeItemClasses, getTreeItemUtilityClass } from './treeItemClasses';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+const useUtilityClasses = ownerState => {
+  const {
+    classes
+  } = ownerState;
+  const slots = {
+    root: ['root'],
+    content: ['content'],
+    expanded: ['expanded'],
+    selected: ['selected'],
+    focused: ['focused'],
+    disabled: ['disabled'],
+    iconContainer: ['iconContainer'],
+    label: ['label'],
+    group: ['group']
+  };
+  return composeClasses(slots, getTreeItemUtilityClass, classes);
+};
+const TreeItemRoot = styled('li', {
+  name: 'MuiTreeItem',
+  slot: 'Root',
+  overridesResolver: (props, styles) => styles.root
+})({
+  listStyle: 'none',
+  margin: 0,
+  padding: 0,
+  outline: 0
+});
+const StyledTreeItemContent = styled(TreeItemContent, {
+  name: 'MuiTreeItem',
+  slot: 'Content',
+  overridesResolver: (props, styles) => {
+    return [styles.content, styles.iconContainer && {
+      [`& .${treeItemClasses.iconContainer}`]: styles.iconContainer
+    }, styles.label && {
+      [`& .${treeItemClasses.label}`]: styles.label
+    }];
+  }
+})(({
+  theme
+}) => ({
+  padding: '0 8px',
+  width: '100%',
+  display: 'flex',
+  alignItems: 'center',
+  cursor: 'pointer',
+  WebkitTapHighlightColor: 'transparent',
+  '&:hover': {
+    backgroundColor: (theme.vars || theme).palette.action.hover,
+    // Reset on touch devices, it doesn't add specificity
+    '@media (hover: none)': {
+      backgroundColor: 'transparent'
+    }
+  },
+  [`&.${treeItemClasses.disabled}`]: {
+    opacity: (theme.vars || theme).palette.action.disabledOpacity,
+    backgroundColor: 'transparent'
+  },
+  [`&.${treeItemClasses.focused}`]: {
+    backgroundColor: (theme.vars || theme).palette.action.focus
+  },
+  [`&.${treeItemClasses.selected}`]: {
+    backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.selectedOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity),
+    '&:hover': {
+      backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / calc(${theme.vars.palette.action.selectedOpacity} + ${theme.vars.palette.action.hoverOpacity}))` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity + theme.palette.action.hoverOpacity),
+      // Reset on touch devices, it doesn't add specificity
+      '@media (hover: none)': {
+        backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / ${theme.vars.palette.action.selectedOpacity})` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity)
+      }
+    },
+    [`&.${treeItemClasses.focused}`]: {
+      backgroundColor: theme.vars ? `rgba(${theme.vars.palette.primary.mainChannel} / calc(${theme.vars.palette.action.selectedOpacity} + ${theme.vars.palette.action.focusOpacity}))` : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity + theme.palette.action.focusOpacity)
+    }
+  },
+  [`& .${treeItemClasses.iconContainer}`]: {
+    marginRight: 4,
+    width: 15,
+    display: 'flex',
+    flexShrink: 0,
+    justifyContent: 'center',
+    '& svg': {
+      fontSize: 18
+    }
+  },
+  [`& .${treeItemClasses.label}`]: _extends({
+    width: '100%',
+    // fixes overflow - see https://github.com/mui/material-ui/issues/27372
+    minWidth: 0,
+    paddingLeft: 4,
+    position: 'relative'
+  }, theme.typography.body1)
+}));
+const TreeItemGroup = styled(Collapse, {
+  name: 'MuiTreeItem',
+  slot: 'Group',
+  overridesResolver: (props, styles) => styles.group
+})({
+  margin: 0,
+  padding: 0,
+  marginLeft: 17
+});
+
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/material-ui/react-tree-view/)
+ *
+ * API:
+ *
+ * - [TreeItem API](https://mui.com/material-ui/api/tree-item/)
+ */
+export const TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiTreeItem'
+  });
+  const {
+      children,
+      className,
+      collapseIcon,
+      ContentComponent = TreeItemContent,
+      ContentProps,
+      endIcon,
+      expandIcon,
+      disabled: disabledProp,
+      icon,
+      id: idProp,
+      label,
+      nodeId,
+      onClick,
+      onMouseDown,
+      TransitionComponent = Collapse,
+      TransitionProps
+    } = props,
+    other = _objectWithoutPropertiesLoose(props, _excluded);
+  const {
+    icons: contextIcons,
+    focus,
+    isExpanded,
+    isFocused,
+    isSelected,
+    isDisabled,
+    multiSelect,
+    disabledItemsFocusable,
+    mapFirstChar,
+    unMapFirstChar,
+    registerNode,
+    unregisterNode,
+    treeId
+  } = React.useContext(TreeViewContext);
+  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 = isExpanded ? isExpanded(nodeId) : false;
+  const focused = isFocused ? isFocused(nodeId) : false;
+  const selected = isSelected ? isSelected(nodeId) : false;
+  const disabled = isDisabled ? isDisabled(nodeId) : false;
+  const ownerState = _extends({}, props, {
+    expanded,
+    focused,
+    selected,
+    disabled
+  });
+  const classes = useUtilityClasses(ownerState);
+  let displayIcon;
+  let expansionIcon;
+  if (expandable) {
+    if (!expanded) {
+      expansionIcon = expandIcon || contextIcons.defaultExpandIcon;
+    } else {
+      expansionIcon = collapseIcon || contextIcons.defaultCollapseIcon;
+    }
+  }
+  if (expandable) {
+    displayIcon = contextIcons.defaultParentIcon;
+  } 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 (registerNode && unregisterNode && index !== -1) {
+      registerNode({
+        id: nodeId,
+        idAttribute: id,
+        index,
+        parentId,
+        expandable,
+        disabled: disabledProp
+      });
+      return () => {
+        unregisterNode(nodeId);
+      };
+    }
+    return undefined;
+  }, [registerNode, unregisterNode, parentId, index, nodeId, expandable, disabledProp, id]);
+  React.useEffect(() => {
+    if (mapFirstChar && unMapFirstChar && label) {
+      mapFirstChar(nodeId, (contentRef.current?.textContent ?? '').substring(0, 1).toLowerCase());
+      return () => {
+        unMapFirstChar(nodeId);
+      };
+    }
+    return undefined;
+  }, [mapFirstChar, unMapFirstChar, nodeId, label]);
+  let ariaSelected;
+  if (multiSelect) {
+    ariaSelected = selected;
+  } else if (selected) {
+    /* single-selection trees unset aria-selected on un-selected items.
+     *
+     * If the tree does not support multiple selection, aria-selected
+     * is set to true for the selected node and it is not present on any other node in the tree.
+     * Source: https://www.w3.org/WAI/ARIA/apg/patterns/treeview/
+     */
+    ariaSelected = true;
+  }
+  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
+      });
+    }
+    const unfocusable = !disabledItemsFocusable && disabled;
+    if (!focused && event.currentTarget === event.target && !unfocusable) {
+      focus(event, nodeId);
+    }
+  }
+  return /*#__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,
+    tabIndex: -1
+  }, other, {
+    ownerState: ownerState,
+    onFocus: handleFocus,
+    ref: handleRef,
+    children: [/*#__PURE__*/_jsx(StyledTreeItemContent, _extends({
+      as: ContentComponent,
+      ref: contentRef,
+      classes: {
+        root: classes.content,
+        expanded: classes.expanded,
+        selected: classes.selected,
+        focused: classes.focused,
+        disabled: classes.disabled,
+        iconContainer: classes.iconContainer,
+        label: classes.label
+      },
+      label: label,
+      nodeId: nodeId,
+      onClick: onClick,
+      onMouseDown: onMouseDown,
+      icon: icon,
+      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
+      }))
+    })]
+  }));
+});
+process.env.NODE_ENV !== "production" ? TreeItem.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 icon used to collapse the node.
+   */
+  collapseIcon: PropTypes.node,
+  /**
+   * The component used for the content node.
+   * @default TreeItemContent
+   */
+  ContentComponent: elementTypeAcceptingRef,
+  /**
+   * Props applied to ContentComponent.
+   */
+  ContentProps: PropTypes.object,
+  /**
+   * If `true`, the node is disabled.
+   * @default false
+   */
+  disabled: PropTypes.bool,
+  /**
+   * The icon displayed next to an end node.
+   */
+  endIcon: PropTypes.node,
+  /**
+   * The icon used to expand the node.
+   */
+  expandIcon: PropTypes.node,
+  /**
+   * The icon to display next to the tree node's label.
+   */
+  icon: PropTypes.node,
+  /**
+   * The tree node label.
+   */
+  label: PropTypes.node,
+  /**
+   * The id of the node.
+   */
+  nodeId: PropTypes.string.isRequired,
+  /**
+   * This prop isn't supported.
+   * Use the `onNodeFocus` callback on the tree if you need to monitor a node's focus.
+   */
+  onFocus: unsupportedProp,
+  /**
+   * 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]),
+  /**
+   * The component used for the transition.
+   * [Follow this guide](/material-ui/transitions/#transitioncomponent-prop) to learn more about the requirements for this component.
+   * @default Collapse
+   */
+  TransitionComponent: PropTypes.elementType,
+  /**
+   * Props applied to the transition element.
+   * 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/TreeItem.types.js

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