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

package/README.md

@@ -16,7 +16,6 @@ This component has the following peer dependencies that you will need to install
 ```json
 "peerDependencies": {
   "@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"
 },

package/RichTreeView/RichTreeView.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import { RichTreeViewProps } from './RichTreeView.types';
+export declare const RichTreeViewRoot: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material/styles").Theme> & {
+    ownerState: RichTreeViewProps<any, any>;
+}, Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLUListElement>, HTMLUListElement>, keyof React.ClassAttributes<HTMLUListElement> | keyof React.HTMLAttributes<HTMLUListElement>>, {}>;
+type TreeViewComponent = (<R extends {}, Multiple extends boolean | undefined = undefined>(props: RichTreeViewProps<R, Multiple> & React.RefAttributes<HTMLUListElement>) => React.JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/x/react-tree-view/)
+ *
+ * API:
+ *
+ * - [RichTreeView API](https://mui.com/x/api/tree-view/rich-tree-view/)
+ */
+declare const RichTreeView: TreeViewComponent;
+export { RichTreeView };

package/RichTreeView/RichTreeView.js

@@ -0,0 +1,324 @@
+import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
+import _extends from "@babel/runtime/helpers/esm/extends";
+const _excluded = ["disabledItemsFocusable", "expandedNodes", "defaultExpandedNodes", "onExpandedNodesChange", "onNodeExpansionToggle", "onNodeFocus", "disableSelection", "defaultSelectedNodes", "selectedNodes", "multiSelect", "onSelectedNodesChange", "onNodeSelectionToggle", "id", "defaultCollapseIcon", "defaultEndIcon", "defaultExpandIcon", "defaultParentIcon", "items", "getItemId", "getItemLabel", "isItemDisabled", "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 { 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
+}) {
+  var _slots$item;
+  const Item = (_slots$item = slots == null ? void 0 : slots.item) != null ? _slots$item : TreeItem;
+  const itemProps = useSlotProps({
+    elementType: Item,
+    externalSlotProps: slotProps == null ? void 0 : slotProps.item,
+    additionalProps: {
+      nodeId,
+      id,
+      label
+    },
+    ownerState: {
+      nodeId,
+      label
+    }
+  });
+  return /*#__PURE__*/_jsx(Item, _extends({}, itemProps, {
+    children: children
+  }));
+}
+const childrenWarning = buildWarning(['MUI: 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) {
+  var _slots$root;
+  const props = useThemeProps({
+    props: inProps,
+    name: 'MuiRichTreeView'
+  });
+  const _ref = props,
+    {
+      // Headless implementation
+      disabledItemsFocusable,
+      expandedNodes,
+      defaultExpandedNodes,
+      onExpandedNodesChange,
+      onNodeExpansionToggle,
+      onNodeFocus,
+      disableSelection,
+      defaultSelectedNodes,
+      selectedNodes,
+      multiSelect,
+      onSelectedNodesChange,
+      onNodeSelectionToggle,
+      id: treeId,
+      defaultCollapseIcon,
+      defaultEndIcon,
+      defaultExpandIcon,
+      defaultParentIcon,
+      items,
+      getItemId,
+      getItemLabel,
+      isItemDisabled,
+      // Component implementation
+      slots,
+      slotProps
+    } = _ref,
+    other = _objectWithoutPropertiesLoose(_ref, _excluded);
+  if (process.env.NODE_ENV !== 'production') {
+    if (props.children != null) {
+      childrenWarning();
+    }
+  }
+  const {
+    getRootProps,
+    contextValue,
+    instance
+  } = useTreeView({
+    disabledItemsFocusable,
+    expandedNodes,
+    defaultExpandedNodes,
+    onExpandedNodesChange,
+    onNodeExpansionToggle,
+    onNodeFocus,
+    disableSelection,
+    defaultSelectedNodes,
+    selectedNodes,
+    multiSelect,
+    onSelectedNodesChange,
+    onNodeSelectionToggle,
+    id: treeId,
+    defaultCollapseIcon,
+    defaultEndIcon,
+    defaultExpandIcon,
+    defaultParentIcon,
+    items,
+    getItemId,
+    getItemLabel,
+    isItemDisabled,
+    plugins: DEFAULT_TREE_VIEW_PLUGINS,
+    rootRef: ref
+  });
+  const classes = useUtilityClasses(props);
+  const Root = (_slots$root = slots == null ? void 0 : slots.root) != null ? _slots$root : RichTreeViewRoot;
+  const rootProps = useSlotProps({
+    elementType: Root,
+    externalSlotProps: slotProps == null ? void 0 : slotProps.root,
+    externalForwardedProps: other,
+    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 == null ? void 0 : 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/RichTreeView/RichTreeView.types.d.ts

@@ -0,0 +1,55 @@
+import * as React from 'react';
+import { Theme } from '@mui/material/styles';
+import { SxProps } from '@mui/system';
+import { SlotComponentProps } from '@mui/base/utils';
+import { RichTreeViewClasses } from './richTreeViewClasses';
+import { DefaultTreeViewPluginParameters } from '../internals/plugins/defaultPlugins';
+import { TreeItem, TreeItemProps } from '../TreeItem';
+import { TreeViewItemId } from '../models';
+interface RichTreeViewItemSlotOwnerState {
+    nodeId: TreeViewItemId;
+    label: string;
+}
+export interface RichTreeViewSlotsComponent {
+    /**
+     * Element rendered at the root.
+     * @default TreeViewRoot
+     */
+    root?: React.ElementType;
+    /**
+     * Custom component for the item.
+     * @default TreeItem.
+     */
+    item?: React.JSXElementConstructor<TreeItemProps>;
+}
+export interface RichTreeViewSlotsComponentsProps<R extends {}, Multiple extends boolean | undefined> {
+    root?: SlotComponentProps<'ul', {}, RichTreeViewProps<R, Multiple>>;
+    item?: SlotComponentProps<typeof TreeItem, {}, RichTreeViewItemSlotOwnerState>;
+}
+export interface RichTreeViewPropsBase extends React.HTMLAttributes<HTMLUListElement> {
+    /**
+     * className applied to the root element.
+     */
+    className?: string;
+    /**
+     * Override or extend the styles applied to the component.
+     */
+    classes?: Partial<RichTreeViewClasses>;
+    /**
+     * The system prop that allows defining system overrides as well as additional CSS styles.
+     */
+    sx?: SxProps<Theme>;
+}
+export interface RichTreeViewProps<R extends {}, Multiple extends boolean | undefined> extends DefaultTreeViewPluginParameters<R, Multiple>, RichTreeViewPropsBase {
+    /**
+     * Overridable component slots.
+     * @default {}
+     */
+    slots?: RichTreeViewSlotsComponent;
+    /**
+     * The props used for each component slot.
+     * @default {}
+     */
+    slotProps?: RichTreeViewSlotsComponentsProps<R, Multiple>;
+}
+export {};

package/RichTreeView/RichTreeView.types.js

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

package/RichTreeView/index.d.ts

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

package/RichTreeView/index.js

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

package/RichTreeView/package.json

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

package/RichTreeView/richTreeViewClasses.d.ts

@@ -0,0 +1,7 @@
+export interface RichTreeViewClasses {
+    /** Styles applied to the root element. */
+    root: string;
+}
+export type RichTreeViewClassKey = keyof RichTreeViewClasses;
+export declare function getRichTreeViewUtilityClass(slot: string): string;
+export declare const richTreeViewClasses: RichTreeViewClasses;

package/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']);

package/SimpleTreeView/SimpleTreeView.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react';
+import { SimpleTreeViewProps } from './SimpleTreeView.types';
+export declare const SimpleTreeViewRoot: import("@emotion/styled").StyledComponent<import("@mui/system").MUIStyledCommonProps<import("@mui/material/styles").Theme> & {
+    ownerState: SimpleTreeViewProps<any>;
+}, Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLUListElement>, HTMLUListElement>, keyof React.ClassAttributes<HTMLUListElement> | keyof React.HTMLAttributes<HTMLUListElement>>, {}>;
+type SimpleTreeViewComponent = (<Multiple extends boolean | undefined = undefined>(props: SimpleTreeViewProps<Multiple> & React.RefAttributes<HTMLUListElement>) => React.JSX.Element) & {
+    propTypes?: any;
+};
+/**
+ *
+ * Demos:
+ *
+ * - [Tree View](https://mui.com/x/react-tree-view/)
+ *
+ * API:
+ *
+ * - [SimpleTreeView API](https://mui.com/x/api/tree-view/simple-tree-view/)
+ */
+declare const SimpleTreeView: SimpleTreeViewComponent;
+export { SimpleTreeView };