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

package/legacy/internals/useTreeView/useTreeView.js

@@ -3,7 +3,6 @@ import _slicedToArray from "@babel/runtime/helpers/esm/slicedToArray";
 import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
 import * as React from 'react';
 import useForkRef from '@mui/utils/useForkRef';
-import { DEFAULT_TREE_VIEW_CONTEXT_VALUE } from '../TreeViewProvider/TreeViewContext';
 import { useTreeViewModels } from './useTreeViewModels';
 import { TREE_VIEW_CORE_PLUGINS } from '../corePlugins';
 export var useTreeView = function useTreeView(inParams) {
@@ -32,7 +31,7 @@ export var useTreeView = function useTreeView(inParams) {
     state = _React$useState2[0],
     setState = _React$useState2[1];
   var rootPropsGetters = [];
-  var contextValue = DEFAULT_TREE_VIEW_CONTEXT_VALUE;
+  var contextValue = {};
   var runPlugin = function runPlugin(plugin) {
     var pluginResponse = plugin({
       instance: instance,
@@ -50,6 +49,42 @@ export var useTreeView = function useTreeView(inParams) {
     }
   };
   plugins.forEach(runPlugin);
+  contextValue.runItemPlugins = function (_ref) {
+    var props = _ref.props,
+      ref = _ref.ref;
+    var finalProps = props;
+    var finalRef = ref;
+    var itemWrappers = [];
+    plugins.forEach(function (plugin) {
+      if (!plugin.itemPlugin) {
+        return;
+      }
+      var itemPluginResponse = plugin.itemPlugin({
+        props: finalProps,
+        ref: finalRef
+      });
+      if (itemPluginResponse != null && itemPluginResponse.props) {
+        finalProps = itemPluginResponse.props;
+      }
+      if (itemPluginResponse != null && itemPluginResponse.ref) {
+        finalRef = itemPluginResponse.ref;
+      }
+      if (itemPluginResponse != null && itemPluginResponse.wrapItem) {
+        itemWrappers.push(itemPluginResponse.wrapItem);
+      }
+    });
+    return {
+      props: finalProps,
+      ref: finalRef,
+      wrapItem: function wrapItem(children) {
+        var finalChildren = children;
+        itemWrappers.forEach(function (itemWrapper) {
+          finalChildren = itemWrapper(finalChildren);
+        });
+        return finalChildren;
+      }
+    };
+  };
   var getRootProps = function getRootProps() {
     var otherHandlers = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     var rootProps = _extends({
@@ -66,6 +101,7 @@ export var useTreeView = function useTreeView(inParams) {
   return {
     getRootProps: getRootProps,
     rootRef: handleRootRef,
-    contextValue: contextValue
+    contextValue: contextValue,
+    instance: instance
   };
 };

package/legacy/internals/useTreeView/useTreeViewModels.js

@@ -58,14 +58,14 @@ export var useTreeViewModels = function useTreeViewModels(plugins, props) {
       var defaultProp = props[model.defaultProp];
       React.useEffect(function () {
         if (model.isControlled !== (controlled !== undefined)) {
-          console.error(["MUI: A component is changing the ".concat(model.isControlled ? '' : 'un', "controlled ").concat(modelName, " state of TreeView to be ").concat(model.isControlled ? 'un' : '', "controlled."), 'Elements should not switch from uncontrolled to controlled (or vice versa).', "Decide between using a controlled or uncontrolled ".concat(modelName, " ") + 'element for the lifetime of the component.', "The nature of the state is determined during the first render. It's considered controlled if the value is not `undefined`.", 'More info: https://fb.me/react-controlled-components'].join('\n'));
+          console.error(["MUI X: A component is changing the ".concat(model.isControlled ? '' : 'un', "controlled ").concat(modelName, " state of TreeView to be ").concat(model.isControlled ? 'un' : '', "controlled."), 'Elements should not switch from uncontrolled to controlled (or vice versa).', "Decide between using a controlled or uncontrolled ".concat(modelName, " ") + 'element for the lifetime of the component.', "The nature of the state is determined during the first render. It's considered controlled if the value is not `undefined`.", 'More info: https://fb.me/react-controlled-components'].join('\n'));
         }
       }, [controlled]);
       var _React$useRef = React.useRef(defaultProp),
         defaultValue = _React$useRef.current;
       React.useEffect(function () {
         if (!model.isControlled && defaultValue !== defaultProp) {
-          console.error(["MUI: A component is changing the default ".concat(modelName, " state of an uncontrolled TreeView after being initialized. ") + "To suppress this warning opt to use a controlled TreeView."].join('\n'));
+          console.error(["MUI X: A component is changing the default ".concat(modelName, " state of an uncontrolled TreeView after being initialized. ") + "To suppress this warning opt to use a controlled TreeView."].join('\n'));
         }
       }, [JSON.stringify(defaultValue)]);
     });

package/legacy/internals/utils/extractPluginParamsFromProps.js

@@ -0,0 +1,27 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+export var extractPluginParamsFromProps = function extractPluginParamsFromProps(_ref) {
+  var props = _ref.props,
+    plugins = _ref.plugins,
+    rootRef = _ref.rootRef;
+  var paramsLookup = {};
+  plugins.forEach(function (plugin) {
+    _extends(paramsLookup, plugin.params);
+  });
+  var pluginParams = {
+    plugins: plugins,
+    rootRef: rootRef
+  };
+  var otherProps = {};
+  Object.keys(props).forEach(function (propName) {
+    var prop = props[propName];
+    if (paramsLookup[propName]) {
+      pluginParams[propName] = prop;
+    } else {
+      otherProps[propName] = prop;
+    }
+  });
+  return {
+    pluginParams: pluginParams,
+    otherProps: otherProps
+  };
+};

package/legacy/internals/utils/warning.js

@@ -0,0 +1,15 @@
+export var buildWarning = function buildWarning(message) {
+  var gravity = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'warning';
+  var alreadyWarned = false;
+  var cleanMessage = Array.isArray(message) ? message.join('\n') : message;
+  return function () {
+    if (!alreadyWarned) {
+      alreadyWarned = true;
+      if (gravity === 'error') {
+        console.error(cleanMessage);
+      } else {
+        console.warn(cleanMessage);
+      }
+    }
+  };
+};

package/legacy/models/index.js

@@ -0,0 +1 @@
+export * from './items';

package/legacy/models/items.js

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

package/models/index.d.ts

@@ -0,0 +1 @@
+export * from './items';

package/models/index.js

@@ -0,0 +1 @@
+export * from './items';

package/models/items.d.ts

@@ -0,0 +1,7 @@
+export type TreeViewItemId = string;
+export type TreeViewBaseItem<R extends {} = {
+    id: string;
+    label: string;
+}> = R & {
+    children?: TreeViewBaseItem<R>[];
+};

package/models/items.js

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

package/models/package.json

@@ -0,0 +1,6 @@
+{
+  "sideEffects": false,
+  "module": "./index.js",
+  "main": "../node/models/index.js",
+  "types": "./index.d.ts"
+}

package/modern/RichTreeView/RichTreeView.js

@@ -0,0 +1,283 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _extends from "@babel/runtime/helpers/esm/extends";
+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 { getRichTreeViewUtilityClass } from './richTreeViewClasses';
+import { useTreeView } from '../internals/useTreeView';
+import { TreeViewProvider } from '../internals/TreeViewProvider';
+import { DEFAULT_TREE_VIEW_PLUGINS } from '../internals/plugins';
+import { TreeItem } from '../TreeItem';
+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, getRichTreeViewUtilityClass, classes);
+};
+export const RichTreeViewRoot = styled('ul', {
+  name: 'MuiRichTreeView',
+  slot: 'Root',
+  overridesResolver: (props, styles) => styles.root
+})({
+  padding: 0,
+  margin: 0,
+  listStyle: 'none',
+  outline: 0
+});
+function WrappedTreeItem({
+  slots,
+  slotProps,
+  label,
+  id,
+  nodeId,
+  children
+}) {
+  const Item = slots?.item ?? TreeItem;
+  const itemProps = useSlotProps({
+    elementType: Item,
+    externalSlotProps: slotProps?.item,
+    additionalProps: {
+      nodeId,
+      id,
+      label
+    },
+    ownerState: {
+      nodeId,
+      label
+    }
+  });
+  return /*#__PURE__*/_jsx(Item, _extends({}, itemProps, {
+    children: children
+  }));
+}
+const childrenWarning = buildWarning(['MUI X: The `RichTreeView` component does not support JSX children.', 'If you want to add items, you need to use the `items` prop', 'Check the documentation for more details: https://next.mui.com/x/react-tree-view/rich-tree-view/items/']);
+
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/x/react-tree-view/)
+ *
+ * API:
+ *
+ * - [RichTreeView API](https://mui.com/x/api/tree-view/rich-tree-view/)
+ */
+const RichTreeView = /*#__PURE__*/React.forwardRef(function RichTreeView(inProps, ref) {
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiRichTreeView'
+  });
+  if (process.env.NODE_ENV !== 'production') {
+    if (props.children != null) {
+      childrenWarning();
+    }
+  }
+  const _extractPluginParamsF = extractPluginParamsFromProps({
+      props,
+      plugins: DEFAULT_TREE_VIEW_PLUGINS,
+      rootRef: ref
+    }),
+    {
+      pluginParams,
+      otherProps: {
+        slots,
+        slotProps
+      }
+    } = _extractPluginParamsF,
+    otherProps = _objectWithoutPropertiesLoose(_extractPluginParamsF.otherProps, _excluded);
+  const {
+    getRootProps,
+    contextValue,
+    instance
+  } = useTreeView(pluginParams);
+  const classes = useUtilityClasses(props);
+  const Root = slots?.root ?? RichTreeViewRoot;
+  const rootProps = useSlotProps({
+    elementType: Root,
+    externalSlotProps: slotProps?.root,
+    externalForwardedProps: otherProps,
+    className: classes.root,
+    getSlotProps: getRootProps,
+    ownerState: props
+  });
+  const nodesToRender = instance.getNodesToRender();
+  const renderNode = ({
+    label,
+    nodeId,
+    id,
+    children
+  }) => {
+    return /*#__PURE__*/_jsx(WrappedTreeItem, {
+      slots: slots,
+      slotProps: slotProps,
+      label: label,
+      id: id,
+      nodeId: nodeId,
+      children: children?.map(renderNode)
+    }, nodeId);
+  };
+  return /*#__PURE__*/_jsx(TreeViewProvider, {
+    value: contextValue,
+    children: /*#__PURE__*/_jsx(Root, _extends({}, rootProps, {
+      children: nodesToRender.map(renderNode)
+    }))
+  });
+});
+process.env.NODE_ENV !== "production" ? RichTreeView.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,
+  /**
+   * 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,
+  /**
+   * Used to determine if a given item should be disabled.
+   * @template R
+   * @param {R} item The item to check.
+   * @returns {boolean} `true` if the item should be disabled.
+   */
+  isItemDisabled: PropTypes.func,
+  items: PropTypes.array.isRequired,
+  /**
+   * 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.
+   * @default {}
+   */
+  slotProps: PropTypes.object,
+  /**
+   * Overridable component slots.
+   * @default {}
+   */
+  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 { RichTreeView };

package/modern/RichTreeView/RichTreeView.types.js

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

package/modern/RichTreeView/index.js

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

package/modern/RichTreeView/richTreeViewClasses.js

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