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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Material-UI SAS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @mui/x-tree-view
+
+This package is the community edition of the tree view components.
+It's part of MUI X, an open-core extension of MUI, with advanced components.
+
+## Installation
+
+Install the package in your project directory with:
+
+```bash
+npm install @mui/x-tree-view
+```
+
+or
+
+```bash
+yarn add @mui/x-tree-view
+```
+
+This component has the following peer dependencies that you will need to install as well.
+
+```json
+"peerDependencies": {
+  "@mui/base": "^5.0.0-alpha.87",
+  "@mui/material": "^5.8.6",
+  "@mui/system": "^5.8.0",
+  "react": "^17.0.0 || ^18.0.0",
+  "react-dom": "^17.0.0 || ^18.0.0"
+},
+```
+
+## Documentation
+
+WIP

package/TreeItem/TreeItem.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { TreeItemProps } from './TreeItem.types';
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/material-ui/react-tree-view/)
+ *
+ * API:
+ *
+ * - [TreeItem API](https://mui.com/material-ui/api/tree-item/)
+ */
+export declare const TreeItem: React.ForwardRefExoticComponent<TreeItemProps & React.RefAttributes<HTMLLIElement>>;

package/TreeItem/TreeItem.js

@@ -0,0 +1,392 @@
+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) {
+      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 () => {
+        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/TreeItem/TreeItem.types.d.ts

@@ -0,0 +1,84 @@
+import * as React from 'react';
+import { Theme } from '@mui/material/styles';
+import { TransitionProps } from '@mui/material/transitions';
+import { SxProps } from '@mui/system';
+import { TreeItemContentProps } from './TreeItemContent';
+import { TreeItemClasses } from './treeItemClasses';
+export interface TreeItemProps extends Omit<React.HTMLAttributes<HTMLLIElement>, 'onFocus'> {
+    /**
+     * The content of the component.
+     */
+    children?: React.ReactNode;
+    /**
+     * className applied to the root element.
+     */
+    className?: string;
+    /**
+     * Override or extend the styles applied to the component.
+     */
+    classes?: Partial<TreeItemClasses>;
+    /**
+     * The icon used to collapse the node.
+     */
+    collapseIcon?: React.ReactNode;
+    /**
+     * The component used for the content node.
+     * @default TreeItemContent
+     */
+    ContentComponent?: React.JSXElementConstructor<TreeItemContentProps>;
+    /**
+     * Props applied to ContentComponent.
+     */
+    ContentProps?: React.HTMLAttributes<HTMLElement>;
+    /**
+     * If `true`, the node is disabled.
+     * @default false
+     */
+    disabled?: boolean;
+    /**
+     * The icon displayed next to an end node.
+     */
+    endIcon?: React.ReactNode;
+    /**
+     * The icon used to expand the node.
+     */
+    expandIcon?: React.ReactNode;
+    /**
+     * The icon to display next to the tree node's label.
+     */
+    icon?: React.ReactNode;
+    /**
+     * This prop isn't supported.
+     * Use the `onNodeFocus` callback on the tree if you need to monitor a node's focus.
+     */
+    onFocus?: null;
+    /**
+     * The tree node label.
+     */
+    label?: React.ReactNode;
+    /**
+     * The id of the node.
+     */
+    nodeId: string;
+    /**
+     * 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?: React.JSXElementConstructor<TransitionProps>;
+    /**
+     * Props applied to the transition element.
+     * By default, the element is based on this [`Transition`](http://reactcommunity.org/react-transition-group/transition/) component.
+     */
+    TransitionProps?: TransitionProps;
+    /**
+     * The system prop that allows defining system overrides as well as additional CSS styles.
+     */
+    sx?: SxProps<Theme>;
+}
+export interface TreeItemOwnerState extends TreeItemProps {
+    expanded: boolean;
+    focused: boolean;
+    selected: boolean;
+    disabled: boolean;
+}

package/TreeItem/TreeItem.types.js

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

package/TreeItem/TreeItemContent.d.ts

@@ -0,0 +1,52 @@
+import * as React from 'react';
+export interface TreeItemContentProps extends React.HTMLAttributes<HTMLElement> {
+    /**
+     * className applied to the root element.
+     */
+    className?: string;
+    /**
+     * Override or extend the styles applied to the component.
+     */
+    classes: {
+        /** Styles applied to the root element. */
+        root: string;
+        /** State class applied to the content element when expanded. */
+        expanded: string;
+        /** State class applied to the content element when selected. */
+        selected: string;
+        /** State class applied to the content element when focused. */
+        focused: string;
+        /** State class applied to the element when disabled. */
+        disabled: string;
+        /** Styles applied to the tree node icon and collapse/expand icon. */
+        iconContainer: string;
+        /** Styles applied to the label element. */
+        label: string;
+    };
+    /**
+     * The tree node label.
+     */
+    label?: React.ReactNode;
+    /**
+     * The id of the node.
+     */
+    nodeId: string;
+    /**
+     * The icon to display next to the tree node's label.
+     */
+    icon?: React.ReactNode;
+    /**
+     * The icon to display next to the tree node's label. Either an expansion or collapse icon.
+     */
+    expansionIcon?: React.ReactNode;
+    /**
+     * The icon to display next to the tree node's label. Either a parent or end icon.
+     */
+    displayIcon?: React.ReactNode;
+}
+export type TreeItemContentClassKey = keyof NonNullable<TreeItemContentProps['classes']>;
+/**
+ * @ignore - internal component.
+ */
+declare const TreeItemContent: React.ForwardRefExoticComponent<TreeItemContentProps & React.RefAttributes<HTMLDivElement>>;
+export { TreeItemContent };