@mui/lab 5.0.0-alpha.142 → 5.0.0-alpha.143

package/TreeItem/TreeItem.js

@@ -1,391 +1,33 @@
-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 clsx from 'clsx';
 import PropTypes from 'prop-types';
-import { elementTypeAcceptingRef } from '@mui/utils';
-import Collapse from '@mui/material/Collapse';
-import { alpha, styled, useThemeProps } from '@mui/material/styles';
-import { ownerDocument, useForkRef, unsupportedProp } from '@mui/material/utils';
-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 { TreeItem as XTreeItem } from '@mui/x-tree-view/TreeItem';
 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
-});
-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 = null;
-  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;
+let warnedOnce = false;
+const warn = () => {
+  if (!warnedOnce) {
+    console.warn(['MUI: The TreeItem component was moved from `@mui/lab` to `@mui/x-tree-view`.', 'The component will no longer be exported from `@mui/lab` in the first release of October 2023.', '', "You should use `import { TreeItem } from '@mui/x-tree-view'`", "or `import { TreeItem } from '@mui/x-tree-view/TreeItem'`", '', 'More information about this migration on our blog: https://mui.com/blog/lab-tree-view-to-mui-x/.'].join('\n'));
+    warnedOnce = true;
   }
-  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 : null,
-    "aria-selected": ariaSelected,
-    "aria-disabled": disabled || null,
-    ref: handleRef,
-    id: id,
-    tabIndex: -1
-  }, other, {
-    ownerState: ownerState,
-    onFocus: handleFocus,
-    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
-      }))
-    })]
+};
+
+/**
+ * @ignore - do not document.
+ */
+const TreeItem = /*#__PURE__*/React.forwardRef(function DeprecatedTreeItem(props, ref) {
+  warn();
+  return /*#__PURE__*/_jsx(XTreeItem, _extends({}, props, {
+    ref: ref
   }));
 });
 process.env.NODE_ENV !== "production" ? TreeItem.propTypes /* remove-proptypes */ = {
   // ----------------------------- Warning --------------------------------
   // | These PropTypes are generated from the TypeScript type definitions |
-  // |     To update them edit the d.ts file and run "yarn proptypes"     |
+  // |     To update them edit 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,
-  /**
-   * @ignore
-   */
-  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 a 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,
-  /**
-   * @ignore
-   */
-  id: PropTypes.string,
-  /**
-   * The tree node label.
-   */
-  label: PropTypes.node,
-  /**
-   * The id of the node.
-   */
-  nodeId: PropTypes.string.isRequired,
-  /**
-   * @ignore
-   */
-  onClick: PropTypes.func,
-  /**
-   * This prop isn't supported.
-   * Use the `onNodeFocus` callback on the tree if you need to monitor a node's focus.
-   */
-  onFocus: unsupportedProp,
-  /**
-   * @ignore
-   */
-  onMouseDown: PropTypes.func,
-  /**
-   * 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
+  children: PropTypes.node
 } : void 0;
 export default TreeItem;

package/TreeItem/index.d.ts

@@ -1,7 +1,3 @@
 export { default } from './TreeItem';
-export * from './TreeItem';
-export * from './TreeItemContent';
-export { default as useTreeItem } from './useTreeItem';
-
-export { default as treeItemClasses } from './treeItemClasses';
-export * from './treeItemClasses';
+export { getTreeItemUtilityClass, treeItemClasses, useTreeItem } from '@mui/x-tree-view/TreeItem';
+export type { TreeItemProps, TreeItemClasses, TreeItemClassKey, TreeItemContentProps, } from '@mui/x-tree-view/TreeItem';

package/TreeItem/index.js

@@ -1,4 +1,2 @@
 export { default } from './TreeItem';
-export { default as useTreeItem } from './useTreeItem';
-export { default as treeItemClasses } from './treeItemClasses';
-export * from './treeItemClasses';
+export { getTreeItemUtilityClass, treeItemClasses, useTreeItem } from '@mui/x-tree-view/TreeItem';

package/TreeView/TreeView.d.ts

@@ -1,144 +1,6 @@
 import * as React from 'react';
-import { InternalStandardProps as StandardProps } from '@mui/material';
-import { Theme } from '@mui/material/styles';
-import { SxProps } from '@mui/system';
-import { TreeViewClasses } from './treeViewClasses';
-
-export interface TreeViewPropsBase extends StandardProps<React.HTMLAttributes<HTMLUListElement>> {
-  /**
-   * The content of the component.
-   */
-  children?: React.ReactNode;
-  /**
-   * Override or extend the styles applied to the component.
-   */
-  classes?: Partial<TreeViewClasses>;
-  /**
-   * The default icon used to collapse the node.
-   */
-  defaultCollapseIcon?: React.ReactNode;
-  /**
-   * 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?: React.ReactNode;
-  /**
-   * Expanded node ids. (Uncontrolled)
-   * @default []
-   */
-  defaultExpanded?: string[];
-  /**
-   * The default icon used to expand the node.
-   */
-  defaultExpandIcon?: React.ReactNode;
-  /**
-   * 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?: React.ReactNode;
-  /**
-   * If `true`, will allow focus on disabled items.
-   * @default false
-   */
-  disabledItemsFocusable?: boolean;
-  /**
-   * If `true` selection is disabled.
-   * @default false
-   */
-  disableSelection?: boolean;
-  /**
-   * Expanded node ids. (Controlled)
-   */
-  expanded?: string[];
-  /**
-   * 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?: string;
-  /**
-   * 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} value of the focused node.
-   */
-  onNodeFocus?: (event: React.SyntheticEvent, nodeId: string) => void;
-  /**
-   * 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.
-   */
-  onNodeToggle?: (event: React.SyntheticEvent, nodeIds: string[]) => void;
-  /**
-   * The system prop that allows defining system overrides as well as additional CSS styles.
-   */
-  sx?: SxProps<Theme>;
-}
-
-export interface MultiSelectTreeViewProps extends TreeViewPropsBase {
-  /**
-   * Selected node ids. (Uncontrolled)
-   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
-   * @default []
-   */
-  defaultSelected?: string[];
-  /**
-   * Selected node ids. (Controlled)
-   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
-   */
-  selected?: string[];
-  /**
-   * If true `ctrl` and `shift` will trigger multiselect.
-   * @default false
-   */
-  multiSelect?: true;
-  /**
-   * 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.
-   */
-  onNodeSelect?: (event: React.SyntheticEvent, nodeIds: string[]) => void;
-}
-
-export interface SingleSelectTreeViewProps extends TreeViewPropsBase {
-  /**
-   * Selected node ids. (Uncontrolled)
-   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
-   * @default []
-   */
-  defaultSelected?: string;
-  /**
-   * Selected node ids. (Controlled)
-   * When `multiSelect` is true this takes an array of strings; when false (default) a string.
-   */
-  selected?: string;
-  /**
-   * If true `ctrl` and `shift` will trigger multiselect.
-   * @default false
-   */
-  multiSelect?: false;
-  /**
-   * 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.
-   */
-  onNodeSelect?: (event: React.SyntheticEvent, nodeIds: string) => void;
-}
-
-export type TreeViewProps = SingleSelectTreeViewProps | MultiSelectTreeViewProps;
-
 /**
- *
- * Demos:
- *
- * - [Tree View](https://mui.com/material-ui/react-tree-view/)
- *
- * API:
- *
- * - [TreeView API](https://mui.com/material-ui/api/tree-view/)
+ * @ignore - do not document.
  */
-export default function TreeView(props: TreeViewProps): JSX.Element;
+declare const TreeView: React.ForwardRefExoticComponent<(Omit<import("@mui/x-tree-view/TreeView").SingleSelectTreeViewProps, "ref"> | Omit<import("@mui/x-tree-view/TreeView").MultiSelectTreeViewProps, "ref">) & React.RefAttributes<HTMLUListElement>>;
+export default TreeView;