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

package/legacy/TreeItem/TreeItem.js

@@ -0,0 +1,391 @@
+import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+var _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";
+var useUtilityClasses = function useUtilityClasses(ownerState) {
+  var classes = ownerState.classes;
+  var slots = {
+    root: ['root'],
+    content: ['content'],
+    expanded: ['expanded'],
+    selected: ['selected'],
+    focused: ['focused'],
+    disabled: ['disabled'],
+    iconContainer: ['iconContainer'],
+    label: ['label'],
+    group: ['group']
+  };
+  return composeClasses(slots, getTreeItemUtilityClass, classes);
+};
+var TreeItemRoot = styled('li', {
+  name: 'MuiTreeItem',
+  slot: 'Root',
+  overridesResolver: function overridesResolver(props, styles) {
+    return styles.root;
+  }
+})({
+  listStyle: 'none',
+  margin: 0,
+  padding: 0,
+  outline: 0
+});
+var StyledTreeItemContent = styled(TreeItemContent, {
+  name: 'MuiTreeItem',
+  slot: 'Content',
+  overridesResolver: function overridesResolver(props, styles) {
+    return [styles.content, styles.iconContainer && _defineProperty({}, "& .".concat(treeItemClasses.iconContainer), styles.iconContainer), styles.label && _defineProperty({}, "& .".concat(treeItemClasses.label), styles.label)];
+  }
+})(function (_ref3) {
+  var _ref4;
+  var theme = _ref3.theme;
+  return _ref4 = {
+    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'
+      }
+    }
+  }, _defineProperty(_ref4, "&.".concat(treeItemClasses.disabled), {
+    opacity: (theme.vars || theme).palette.action.disabledOpacity,
+    backgroundColor: 'transparent'
+  }), _defineProperty(_ref4, "&.".concat(treeItemClasses.focused), {
+    backgroundColor: (theme.vars || theme).palette.action.focus
+  }), _defineProperty(_ref4, "&.".concat(treeItemClasses.selected), _defineProperty({
+    backgroundColor: theme.vars ? "rgba(".concat(theme.vars.palette.primary.mainChannel, " / ").concat(theme.vars.palette.action.selectedOpacity, ")") : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity),
+    '&:hover': {
+      backgroundColor: theme.vars ? "rgba(".concat(theme.vars.palette.primary.mainChannel, " / calc(").concat(theme.vars.palette.action.selectedOpacity, " + ").concat(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(".concat(theme.vars.palette.primary.mainChannel, " / ").concat(theme.vars.palette.action.selectedOpacity, ")") : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity)
+      }
+    }
+  }, "&.".concat(treeItemClasses.focused), {
+    backgroundColor: theme.vars ? "rgba(".concat(theme.vars.palette.primary.mainChannel, " / calc(").concat(theme.vars.palette.action.selectedOpacity, " + ").concat(theme.vars.palette.action.focusOpacity, "))") : alpha(theme.palette.primary.main, theme.palette.action.selectedOpacity + theme.palette.action.focusOpacity)
+  })), _defineProperty(_ref4, "& .".concat(treeItemClasses.iconContainer), {
+    marginRight: 4,
+    width: 15,
+    display: 'flex',
+    flexShrink: 0,
+    justifyContent: 'center',
+    '& svg': {
+      fontSize: 18
+    }
+  }), _defineProperty(_ref4, "& .".concat(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)), _ref4;
+});
+var TreeItemGroup = styled(Collapse, {
+  name: 'MuiTreeItem',
+  slot: 'Group',
+  overridesResolver: function overridesResolver(props, styles) {
+    return 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 var TreeItem = /*#__PURE__*/React.forwardRef(function TreeItem(inProps, ref) {
+  var props = useThemeProps({
+    props: inProps,
+    name: 'MuiTreeItem'
+  });
+  var children = props.children,
+    className = props.className,
+    collapseIcon = props.collapseIcon,
+    _props$ContentCompone = props.ContentComponent,
+    ContentComponent = _props$ContentCompone === void 0 ? TreeItemContent : _props$ContentCompone,
+    ContentProps = props.ContentProps,
+    endIcon = props.endIcon,
+    expandIcon = props.expandIcon,
+    disabledProp = props.disabled,
+    icon = props.icon,
+    idProp = props.id,
+    label = props.label,
+    nodeId = props.nodeId,
+    onClick = props.onClick,
+    onMouseDown = props.onMouseDown,
+    _props$TransitionComp = props.TransitionComponent,
+    TransitionComponent = _props$TransitionComp === void 0 ? Collapse : _props$TransitionComp,
+    TransitionProps = props.TransitionProps,
+    other = _objectWithoutProperties(props, _excluded);
+  var _React$useContext = React.useContext(TreeViewContext),
+    contextIcons = _React$useContext.icons,
+    focus = _React$useContext.focus,
+    isExpanded = _React$useContext.isExpanded,
+    isFocused = _React$useContext.isFocused,
+    isSelected = _React$useContext.isSelected,
+    isDisabled = _React$useContext.isDisabled,
+    multiSelect = _React$useContext.multiSelect,
+    disabledItemsFocusable = _React$useContext.disabledItemsFocusable,
+    mapFirstChar = _React$useContext.mapFirstChar,
+    unMapFirstChar = _React$useContext.unMapFirstChar,
+    registerNode = _React$useContext.registerNode,
+    unregisterNode = _React$useContext.unregisterNode,
+    treeId = _React$useContext.treeId;
+  var id;
+  if (idProp != null) {
+    id = idProp;
+  } else if (treeId && nodeId) {
+    id = "".concat(treeId, "-").concat(nodeId);
+  }
+  var _React$useState = React.useState(null),
+    _React$useState2 = _slicedToArray(_React$useState, 2),
+    treeItemElement = _React$useState2[0],
+    setTreeItemElement = _React$useState2[1];
+  var contentRef = React.useRef(null);
+  var handleRef = useForkRef(setTreeItemElement, ref);
+  var descendant = React.useMemo(function () {
+    return {
+      element: treeItemElement,
+      id: nodeId
+    };
+  }, [nodeId, treeItemElement]);
+  var _useDescendant = useDescendant(descendant),
+    index = _useDescendant.index,
+    parentId = _useDescendant.parentId;
+  var expandable = Boolean(Array.isArray(children) ? children.length : children);
+  var expanded = isExpanded ? isExpanded(nodeId) : false;
+  var focused = isFocused ? isFocused(nodeId) : false;
+  var selected = isSelected ? isSelected(nodeId) : false;
+  var disabled = isDisabled ? isDisabled(nodeId) : false;
+  var ownerState = _extends({}, props, {
+    expanded: expanded,
+    focused: focused,
+    selected: selected,
+    disabled: disabled
+  });
+  var classes = useUtilityClasses(ownerState);
+  var displayIcon;
+  var 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(function () {
+    // 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: index,
+        parentId: parentId,
+        expandable: expandable,
+        disabled: disabledProp
+      });
+      return function () {
+        unregisterNode(nodeId);
+      };
+    }
+    return undefined;
+  }, [registerNode, unregisterNode, parentId, index, nodeId, expandable, disabledProp, id]);
+  React.useEffect(function () {
+    if (mapFirstChar && unMapFirstChar && label) {
+      var _contentRef$current$t, _contentRef$current;
+      mapFirstChar(nodeId, ((_contentRef$current$t = (_contentRef$current = contentRef.current) == null ? void 0 : _contentRef$current.textContent) != null ? _contentRef$current$t : '').substring(0, 1).toLowerCase());
+      return function () {
+        unMapFirstChar(nodeId);
+      };
+    }
+    return undefined;
+  }, [mapFirstChar, unMapFirstChar, nodeId, label]);
+  var 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) {
+      var rootElement;
+      if (typeof event.target.getRootNode === 'function') {
+        rootElement = event.target.getRootNode();
+      } else {
+        rootElement = ownerDocument(event.target);
+      }
+      rootElement.getElementById(treeId).focus({
+        preventScroll: true
+      });
+    }
+    var 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/legacy/TreeItem/TreeItem.types.js

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

package/legacy/TreeItem/TreeItemContent.js

@@ -0,0 +1,98 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
+var _excluded = ["classes", "className", "displayIcon", "expansionIcon", "icon", "label", "nodeId", "onClick", "onMouseDown"];
+import * as React from 'react';
+import PropTypes from 'prop-types';
+import clsx from 'clsx';
+import { useTreeItem } from './useTreeItem';
+import { jsx as _jsx } from "react/jsx-runtime";
+import { jsxs as _jsxs } from "react/jsx-runtime";
+/**
+ * @ignore - internal component.
+ */
+var TreeItemContent = /*#__PURE__*/React.forwardRef(function TreeItemContent(props, ref) {
+  var classes = props.classes,
+    className = props.className,
+    displayIcon = props.displayIcon,
+    expansionIcon = props.expansionIcon,
+    iconProp = props.icon,
+    label = props.label,
+    nodeId = props.nodeId,
+    onClick = props.onClick,
+    onMouseDown = props.onMouseDown,
+    other = _objectWithoutProperties(props, _excluded);
+  var _useTreeItem = useTreeItem(nodeId),
+    disabled = _useTreeItem.disabled,
+    expanded = _useTreeItem.expanded,
+    selected = _useTreeItem.selected,
+    focused = _useTreeItem.focused,
+    handleExpansion = _useTreeItem.handleExpansion,
+    handleSelection = _useTreeItem.handleSelection,
+    preventSelection = _useTreeItem.preventSelection;
+  var icon = iconProp || expansionIcon || displayIcon;
+  var handleMouseDown = function handleMouseDown(event) {
+    preventSelection(event);
+    if (onMouseDown) {
+      onMouseDown(event);
+    }
+  };
+  var handleClick = function handleClick(event) {
+    handleExpansion(event);
+    handleSelection(event);
+    if (onClick) {
+      onClick(event);
+    }
+  };
+  return (
+    /*#__PURE__*/
+    /* eslint-disable-next-line jsx-a11y/click-events-have-key-events,jsx-a11y/no-static-element-interactions -- Key event is handled by the TreeView */
+    _jsxs("div", _extends({}, other, {
+      className: clsx(className, classes.root, expanded && classes.expanded, selected && classes.selected, focused && classes.focused, disabled && classes.disabled),
+      onClick: handleClick,
+      onMouseDown: handleMouseDown,
+      ref: ref,
+      children: [/*#__PURE__*/_jsx("div", {
+        className: classes.iconContainer,
+        children: icon
+      }), /*#__PURE__*/_jsx("div", {
+        className: classes.label,
+        children: label
+      })]
+    }))
+  );
+});
+process.env.NODE_ENV !== "production" ? TreeItemContent.propTypes = {
+  // ----------------------------- Warning --------------------------------
+  // | These PropTypes are generated from the TypeScript type definitions |
+  // | To update them edit the TypeScript types and run "yarn proptypes"  |
+  // ----------------------------------------------------------------------
+  /**
+   * Override or extend the styles applied to the component.
+   */
+  classes: PropTypes.object.isRequired,
+  /**
+   * className applied to the root element.
+   */
+  className: PropTypes.string,
+  /**
+   * The icon to display next to the tree node's label. Either a parent or end icon.
+   */
+  displayIcon: PropTypes.node,
+  /**
+   * The icon to display next to the tree node's label. Either an expansion or collapse icon.
+   */
+  expansionIcon: 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
+} : void 0;
+export { TreeItemContent };

package/legacy/TreeItem/index.js

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

package/legacy/TreeItem/treeItemClasses.js

@@ -0,0 +1,6 @@
+import generateUtilityClass from '@mui/utils/generateUtilityClass';
+import generateUtilityClasses from '@mui/utils/generateUtilityClasses';
+export function getTreeItemUtilityClass(slot) {
+  return generateUtilityClass('MuiTreeItem', slot);
+}
+export var treeItemClasses = generateUtilityClasses('MuiTreeItem', ['root', 'group', 'content', 'expanded', 'selected', 'focused', 'disabled', 'iconContainer', 'label']);

package/legacy/TreeItem/useTreeItem.js

@@ -0,0 +1,67 @@
+import * as React from 'react';
+import { TreeViewContext } from '../TreeView/TreeViewContext';
+export function useTreeItem(nodeId) {
+  var _React$useContext = React.useContext(TreeViewContext),
+    focus = _React$useContext.focus,
+    isExpanded = _React$useContext.isExpanded,
+    isExpandable = _React$useContext.isExpandable,
+    isFocused = _React$useContext.isFocused,
+    isDisabled = _React$useContext.isDisabled,
+    isSelected = _React$useContext.isSelected,
+    multiSelect = _React$useContext.multiSelect,
+    selectNode = _React$useContext.selectNode,
+    selectRange = _React$useContext.selectRange,
+    toggleExpansion = _React$useContext.toggleExpansion;
+  var expandable = isExpandable ? isExpandable(nodeId) : false;
+  var expanded = isExpanded ? isExpanded(nodeId) : false;
+  var focused = isFocused ? isFocused(nodeId) : false;
+  var disabled = isDisabled ? isDisabled(nodeId) : false;
+  var selected = isSelected ? isSelected(nodeId) : false;
+  var handleExpansion = function handleExpansion(event) {
+    if (!disabled) {
+      if (!focused) {
+        focus(event, nodeId);
+      }
+      var multiple = multiSelect && (event.shiftKey || event.ctrlKey || event.metaKey);
+
+      // If already expanded and trying to toggle selection don't close
+      if (expandable && !(multiple && isExpanded(nodeId))) {
+        toggleExpansion(event, nodeId);
+      }
+    }
+  };
+  var handleSelection = function handleSelection(event) {
+    if (!disabled) {
+      if (!focused) {
+        focus(event, nodeId);
+      }
+      var multiple = multiSelect && (event.shiftKey || event.ctrlKey || event.metaKey);
+      if (multiple) {
+        if (event.shiftKey) {
+          selectRange(event, {
+            end: nodeId
+          });
+        } else {
+          selectNode(event, nodeId, true);
+        }
+      } else {
+        selectNode(event, nodeId);
+      }
+    }
+  };
+  var preventSelection = function preventSelection(event) {
+    if (event.shiftKey || event.ctrlKey || event.metaKey || disabled) {
+      // Prevent text selection
+      event.preventDefault();
+    }
+  };
+  return {
+    disabled: disabled,
+    expanded: expanded,
+    selected: selected,
+    focused: focused,
+    handleExpansion: handleExpansion,
+    handleSelection: handleSelection,
+    preventSelection: preventSelection
+  };
+}