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

package/internals/plugins/useTreeViewNodes/useTreeViewNodes.types.d.ts

@@ -1,20 +1,52 @@
 import { TreeViewNode, DefaultizedProps, TreeViewPluginSignature } from '../../models';
+import { TreeViewItemId } from '../../../models';
+interface TreeViewNodeProps {
+    label: string;
+    nodeId: string;
+    id: string | undefined;
+    children?: TreeViewNodeProps[];
+}
 export interface UseTreeViewNodesInstance {
     getNode: (nodeId: string) => TreeViewNode;
-    updateNode: (node: TreeViewNode) => void;
-    removeNode: (nodeId: string) => void;
+    getNodesToRender: () => TreeViewNodeProps[];
     getChildrenIds: (nodeId: string | null) => string[];
     getNavigableChildrenIds: (nodeId: string | null) => string[];
     isNodeDisabled: (nodeId: string | null) => nodeId is string;
 }
-export interface UseTreeViewNodesParameters {
+export interface UseTreeViewNodesParameters<R extends {}> {
     /**
      * If `true`, will allow focus on disabled items.
      * @default false
      */
     disabledItemsFocusable?: boolean;
+    items: readonly R[];
+    /**
+     * 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?: (item: R) => boolean;
+    /**
+     * 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?: (item: R) => 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?: (item: R) => TreeViewItemId;
 }
-export type UseTreeViewNodesDefaultizedParameters = DefaultizedProps<UseTreeViewNodesParameters, 'disabledItemsFocusable'>;
+export type UseTreeViewNodesDefaultizedParameters<R extends {}> = DefaultizedProps<UseTreeViewNodesParameters<R>, 'disabledItemsFocusable'>;
 interface UseTreeViewNodesEventLookup {
     removeNode: {
         params: {
@@ -22,6 +54,17 @@ interface UseTreeViewNodesEventLookup {
         };
     };
 }
-export type UseTreeViewNodesSignature = TreeViewPluginSignature<UseTreeViewNodesParameters, UseTreeViewNodesDefaultizedParameters, UseTreeViewNodesInstance, UseTreeViewNodesEventLookup, {}, never, [
+export interface TreeViewNodeIdAndChildren {
+    id: TreeViewItemId;
+    children?: TreeViewNodeIdAndChildren[];
+}
+export interface UseTreeViewNodesState {
+    nodeTree: TreeViewNodeIdAndChildren[];
+    nodeMap: TreeViewNodeMap;
+}
+export type UseTreeViewNodesSignature = TreeViewPluginSignature<UseTreeViewNodesParameters<any>, UseTreeViewNodesDefaultizedParameters<any>, UseTreeViewNodesInstance, UseTreeViewNodesEventLookup, UseTreeViewNodesState, never, [
 ]>;
+export type TreeViewNodeMap = {
+    [nodeId: string]: TreeViewNode;
+};
 export {};

package/internals/plugins/useTreeViewSelection/useTreeViewSelection.d.ts

@@ -1,3 +1,3 @@
 import { TreeViewPlugin } from '../../models';
 import { UseTreeViewSelectionSignature } from './useTreeViewSelection.types';
-export declare const useTreeViewSelection: TreeViewPlugin<UseTreeViewSelectionSignature<any>>;
+export declare const useTreeViewSelection: TreeViewPlugin<UseTreeViewSelectionSignature>;

package/internals/plugins/useTreeViewSelection/useTreeViewSelection.js

@@ -10,30 +10,49 @@ export const useTreeViewSelection = ({
   const lastSelectedNode = React.useRef(null);
   const lastSelectionWasRange = React.useRef(false);
   const currentRangeSelection = React.useRef([]);
-  const isNodeSelected = nodeId => Array.isArray(models.selected.value) ? models.selected.value.indexOf(nodeId) !== -1 : models.selected.value === nodeId;
+  const isNodeSelected = nodeId => Array.isArray(models.selectedNodes.value) ? models.selectedNodes.value.indexOf(nodeId) !== -1 : models.selectedNodes.value === nodeId;
+  const setSelectedNodes = (event, newSelectedNodes) => {
+    if (params.onNodeSelectionToggle) {
+      if (params.multiSelect) {
+        const addedNodes = newSelectedNodes.filter(nodeId => !instance.isNodeSelected(nodeId));
+        const removedNodes = models.selectedNodes.value.filter(nodeId => !newSelectedNodes.includes(nodeId));
+        addedNodes.forEach(nodeId => {
+          params.onNodeSelectionToggle(event, nodeId, true);
+        });
+        removedNodes.forEach(nodeId => {
+          params.onNodeSelectionToggle(event, nodeId, false);
+        });
+      } else if (newSelectedNodes !== models.selectedNodes.value) {
+        if (models.selectedNodes.value != null) {
+          params.onNodeSelectionToggle(event, models.selectedNodes.value, false);
+        }
+        if (newSelectedNodes != null) {
+          params.onNodeSelectionToggle(event, newSelectedNodes, true);
+        }
+      }
+    }
+    if (params.onSelectedNodesChange) {
+      params.onSelectedNodesChange(event, newSelectedNodes);
+    }
+    models.selectedNodes.setValue(newSelectedNodes);
+  };
   const selectNode = (event, nodeId, multiple = false) => {
     if (params.disableSelection) {
       return;
     }
     if (multiple) {
-      if (Array.isArray(models.selected.value)) {
+      if (Array.isArray(models.selectedNodes.value)) {
         let newSelected;
-        if (models.selected.value.indexOf(nodeId) !== -1) {
-          newSelected = models.selected.value.filter(id => id !== nodeId);
+        if (models.selectedNodes.value.indexOf(nodeId) !== -1) {
+          newSelected = models.selectedNodes.value.filter(id => id !== nodeId);
         } else {
-          newSelected = [nodeId].concat(models.selected.value);
+          newSelected = [nodeId].concat(models.selectedNodes.value);
         }
-        if (params.onNodeSelect) {
-          params.onNodeSelect(event, newSelected);
-        }
-        models.selected.setValue(newSelected);
+        setSelectedNodes(event, newSelected);
       }
     } else {
       const newSelected = params.multiSelect ? [nodeId] : nodeId;
-      if (params.onNodeSelect) {
-        params.onNodeSelect(event, newSelected);
-      }
-      models.selected.setValue(newSelected);
+      setSelectedNodes(event, newSelected);
     }
     lastSelectedNode.current = nodeId;
     lastSelectionWasRange.current = false;
@@ -50,7 +69,7 @@ export const useTreeViewSelection = ({
     return nodes;
   };
   const handleRangeArrowSelect = (event, nodes) => {
-    let base = models.selected.value.slice();
+    let base = models.selectedNodes.value.slice();
     const {
       start,
       next,
@@ -74,13 +93,10 @@ export const useTreeViewSelection = ({
       base.push(next);
       currentRangeSelection.current.push(current, next);
     }
-    if (params.onNodeSelect) {
-      params.onNodeSelect(event, base);
-    }
-    models.selected.setValue(base);
+    setSelectedNodes(event, base);
   };
   const handleRangeSelect = (event, nodes) => {
-    let base = models.selected.value.slice();
+    let base = models.selectedNodes.value.slice();
     const {
       start,
       end
@@ -94,10 +110,7 @@ export const useTreeViewSelection = ({
     currentRangeSelection.current = range;
     let newSelected = base.concat(range);
     newSelected = newSelected.filter((id, i) => newSelected.indexOf(id) === i);
-    if (params.onNodeSelect) {
-      params.onNodeSelect(event, newSelected);
-    }
-    models.selected.setValue(newSelected);
+    setSelectedNodes(event, newSelected);
   };
   const selectRange = (event, nodes, stacked = false) => {
     if (params.disableSelection) {
@@ -156,17 +169,25 @@ export const useTreeViewSelection = ({
   };
 };
 useTreeViewSelection.models = {
-  selected: {
-    controlledProp: 'selected',
-    defaultProp: 'defaultSelected'
+  selectedNodes: {
+    controlledProp: 'selectedNodes',
+    defaultProp: 'defaultSelectedNodes'
   }
 };
-const DEFAULT_SELECTED = [];
+const DEFAULT_SELECTED_NODES = [];
 useTreeViewSelection.getDefaultizedParams = params => {
   var _params$disableSelect, _params$multiSelect, _params$defaultSelect;
   return _extends({}, params, {
     disableSelection: (_params$disableSelect = params.disableSelection) != null ? _params$disableSelect : false,
     multiSelect: (_params$multiSelect = params.multiSelect) != null ? _params$multiSelect : false,
-    defaultSelected: (_params$defaultSelect = params.defaultSelected) != null ? _params$defaultSelect : params.multiSelect ? DEFAULT_SELECTED : null
+    defaultSelectedNodes: (_params$defaultSelect = params.defaultSelectedNodes) != null ? _params$defaultSelect : params.multiSelect ? DEFAULT_SELECTED_NODES : null
   });
+};
+useTreeViewSelection.params = {
+  disableSelection: true,
+  multiSelect: true,
+  defaultSelectedNodes: true,
+  selectedNodes: true,
+  onSelectedNodesChange: true,
+  onNodeSelectionToggle: true
 };

package/internals/plugins/useTreeViewSelection/useTreeViewSelection.types.d.ts

@@ -21,27 +21,34 @@ export interface UseTreeViewSelectionParameters<Multiple extends boolean | undef
      * When `multiSelect` is true this takes an array of strings; when false (default) a string.
      * @default []
      */
-    defaultSelected?: TreeViewSelectionValue<Multiple>;
+    defaultSelectedNodes?: TreeViewSelectionValue<Multiple>;
     /**
      * Selected node ids. (Controlled)
      * When `multiSelect` is true this takes an array of strings; when false (default) a string.
      */
-    selected?: TreeViewSelectionValue<Multiple>;
+    selectedNodes?: TreeViewSelectionValue<Multiple>;
     /**
      * If true `ctrl` and `shift` will trigger multiselect.
      * @default false
      */
     multiSelect?: Multiple;
     /**
-     * Callback fired when tree items are selected/unselected.
+     * Callback fired when tree items are selected/deselected.
      * @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.
+     * @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.
      */
-    onNodeSelect?: (event: React.SyntheticEvent, nodeIds: Exclude<TreeViewSelectionValue<Multiple>, null>) => void;
+    onSelectedNodesChange?: (event: React.SyntheticEvent, nodeIds: TreeViewSelectionValue<Multiple>) => void;
+    /**
+     * 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?: (event: React.SyntheticEvent, nodeId: string, isSelected: boolean) => void;
 }
-export type UseTreeViewSelectionDefaultizedParameters<Multiple extends boolean> = DefaultizedProps<UseTreeViewSelectionParameters<Multiple>, 'disableSelection' | 'defaultSelected' | 'multiSelect'>;
-export type UseTreeViewSelectionSignature<Multiple extends boolean | undefined> = TreeViewPluginSignature<UseTreeViewSelectionParameters<Multiple>, UseTreeViewSelectionDefaultizedParameters<Multiple extends undefined ? false : Multiple>, UseTreeViewSelectionInstance, {}, {}, 'selected', [
+export type UseTreeViewSelectionDefaultizedParameters<Multiple extends boolean> = DefaultizedProps<UseTreeViewSelectionParameters<Multiple>, 'disableSelection' | 'defaultSelectedNodes' | 'multiSelect'>;
+export type UseTreeViewSelectionSignature = TreeViewPluginSignature<UseTreeViewSelectionParameters<any>, UseTreeViewSelectionDefaultizedParameters<any>, UseTreeViewSelectionInstance, {}, {}, 'selectedNodes', [
     UseTreeViewNodesSignature,
     UseTreeViewExpansionSignature,
     UseTreeViewNodesSignature

package/internals/useTreeView/useTreeView.js

@@ -1,7 +1,6 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 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 const useTreeView = inParams => {
@@ -27,7 +26,7 @@ export const useTreeView = inParams => {
     return temp;
   });
   const rootPropsGetters = [];
-  let contextValue = DEFAULT_TREE_VIEW_CONTEXT_VALUE;
+  let contextValue = {};
   const runPlugin = plugin => {
     const pluginResponse = plugin({
       instance,
@@ -45,6 +44,43 @@ export const useTreeView = inParams => {
     }
   };
   plugins.forEach(runPlugin);
+  contextValue.runItemPlugins = ({
+    props,
+    ref
+  }) => {
+    let finalProps = props;
+    let finalRef = ref;
+    const itemWrappers = [];
+    plugins.forEach(plugin => {
+      if (!plugin.itemPlugin) {
+        return;
+      }
+      const 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: children => {
+        let finalChildren = children;
+        itemWrappers.forEach(itemWrapper => {
+          finalChildren = itemWrapper(finalChildren);
+        });
+        return finalChildren;
+      }
+    };
+  };
   const getRootProps = (otherHandlers = {}) => {
     const rootProps = _extends({
       role: 'tree',
@@ -60,6 +96,7 @@ export const useTreeView = inParams => {
   return {
     getRootProps,
     rootRef: handleRootRef,
-    contextValue
+    contextValue,
+    instance: instance
   };
 };

package/internals/useTreeView/useTreeView.types.d.ts

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { EventHandlers } from '@mui/base/utils';
 import type { TreeViewContextValue } from '../TreeViewProvider';
-import { TreeViewAnyPluginSignature, TreeViewPlugin, ConvertPluginsIntoSignatures, MergePluginsProperty } from '../models';
+import { TreeViewAnyPluginSignature, TreeViewPlugin, ConvertPluginsIntoSignatures, MergePluginsProperty, TreeViewInstance } from '../models';
 export type UseTreeViewParameters<TPlugins extends readonly TreeViewPlugin<TreeViewAnyPluginSignature>[]> = {
     rootRef?: React.Ref<HTMLUListElement> | undefined;
     plugins: TPlugins;
@@ -17,4 +17,5 @@ export interface UseTreeViewReturnValue<TPlugins extends readonly TreeViewAnyPlu
     getRootProps: <TOther extends EventHandlers = {}>(otherHandlers?: TOther) => UseTreeViewRootSlotProps;
     rootRef: React.RefCallback<HTMLUListElement> | null;
     contextValue: TreeViewContextValue<TPlugins>;
+    instance: TreeViewInstance<TPlugins>;
 }

package/internals/useTreeView/useTreeViewModels.js

@@ -44,7 +44,7 @@ export const useTreeViewModels = (plugins, props) => {
       const defaultProp = props[model.defaultProp];
       React.useEffect(() => {
         if (model.isControlled !== (controlled !== undefined)) {
-          console.error([`MUI: A component is changing the ${model.isControlled ? '' : 'un'}controlled ${modelName} state of TreeView to be ${model.isControlled ? 'un' : ''}controlled.`, 'Elements should not switch from uncontrolled to controlled (or vice versa).', `Decide between using a controlled or uncontrolled ${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 ${model.isControlled ? '' : 'un'}controlled ${modelName} state of TreeView to be ${model.isControlled ? 'un' : ''}controlled.`, 'Elements should not switch from uncontrolled to controlled (or vice versa).', `Decide between using a controlled or uncontrolled ${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]);
       const {
@@ -52,7 +52,7 @@ export const useTreeViewModels = (plugins, props) => {
       } = React.useRef(defaultProp);
       React.useEffect(() => {
         if (!model.isControlled && defaultValue !== defaultProp) {
-          console.error([`MUI: A component is changing the default ${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 ${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/internals/utils/extractPluginParamsFromProps.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { ConvertPluginsIntoSignatures, MergePluginsProperty, TreeViewPlugin } from '../models';
+export declare const extractPluginParamsFromProps: <TProps extends {}, TPlugins extends readonly TreeViewPlugin<any>[]>({ props, plugins, rootRef, }: {
+    props: TProps;
+    plugins: TPlugins;
+    rootRef?: React.Ref<HTMLUListElement> | undefined;
+}) => {
+    pluginParams: MergePluginsProperty<ConvertPluginsIntoSignatures<TPlugins>, "params"> & {
+        plugins: TPlugins;
+        rootRef?: React.Ref<HTMLUListElement> | undefined;
+    };
+    otherProps: Omit<TProps, keyof MergePluginsProperty<ConvertPluginsIntoSignatures<TPlugins>, "params">>;
+};

package/internals/utils/extractPluginParamsFromProps.js

@@ -0,0 +1,27 @@
+export const extractPluginParamsFromProps = ({
+  props,
+  plugins,
+  rootRef
+}) => {
+  const paramsLookup = {};
+  plugins.forEach(plugin => {
+    Object.assign(paramsLookup, plugin.params);
+  });
+  const pluginParams = {
+    plugins,
+    rootRef
+  };
+  const otherProps = {};
+  Object.keys(props).forEach(propName => {
+    const prop = props[propName];
+    if (paramsLookup[propName]) {
+      pluginParams[propName] = prop;
+    } else {
+      otherProps[propName] = prop;
+    }
+  });
+  return {
+    pluginParams,
+    otherProps
+  };
+};

package/internals/utils/warning.d.ts

@@ -0,0 +1 @@
+export declare const buildWarning: (message: string | string[], gravity?: 'warning' | 'error') => () => void;

package/internals/utils/warning.js

@@ -0,0 +1,14 @@
+export const buildWarning = (message, gravity = 'warning') => {
+  let alreadyWarned = false;
+  const cleanMessage = Array.isArray(message) ? message.join('\n') : message;
+  return () => {
+    if (!alreadyWarned) {
+      alreadyWarned = true;
+      if (gravity === 'error') {
+        console.error(cleanMessage);
+      } else {
+        console.warn(cleanMessage);
+      }
+    }
+  };
+};