@mui/x-tree-view 8.0.0-alpha.0 → 8.0.0-alpha.2

package/modern/internals/plugins/useTreeViewJSXItems/useTreeViewJSXItems.js

@@ -9,42 +9,45 @@ import { TreeViewChildrenItemContext, TreeViewChildrenItemProvider } from "../..
 import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID } from "../useTreeViewItems/useTreeViewItems.utils.js";
 import { TreeViewItemDepthContext } from "../../TreeViewItemDepthContext/index.js";
 import { generateTreeItemIdAttribute } from "../../corePlugins/useTreeViewId/useTreeViewId.utils.js";
+import { isItemExpandable } from "../../../hooks/useTreeItemUtils/useTreeItemUtils.js";
+import { useSelector } from "../../hooks/useSelector.js";
+import { selectorTreeViewId } from "../../corePlugins/useTreeViewId/useTreeViewId.selectors.js";
 import { jsx as _jsx } from "react/jsx-runtime";
 export const useTreeViewJSXItems = ({
   instance,
-  setState
+  store
 }) => {
   instance.preventItemUpdates();
   const insertJSXItem = useEventCallback(item => {
-    setState(prevState => {
-      if (prevState.items.itemMetaMap[item.id] != null) {
+    store.update(prevState => {
+      if (prevState.items.itemMetaLookup[item.id] != null) {
         throw new Error(['MUI X: The Tree View component requires all items to have a unique `id` property.', 'Alternatively, you can use the `getItemId` prop to specify a custom id for each item.', `Two items were provided with the same id in the \`items\` prop: "${item.id}"`].join('\n'));
       }
       return _extends({}, prevState, {
         items: _extends({}, prevState.items, {
-          itemMetaMap: _extends({}, prevState.items.itemMetaMap, {
+          itemMetaLookup: _extends({}, prevState.items.itemMetaLookup, {
             [item.id]: item
           }),
           // For Simple Tree View, we don't have a proper `item` object, so we create a very basic one.
-          itemMap: _extends({}, prevState.items.itemMap, {
+          itemModelLookup: _extends({}, prevState.items.itemModelLookup, {
             [item.id]: {
               id: item.id,
-              label: item.label
+              label: item.label ?? ''
             }
           })
         })
       });
     });
     return () => {
-      setState(prevState => {
-        const newItemMetaMap = _extends({}, prevState.items.itemMetaMap);
-        const newItemMap = _extends({}, prevState.items.itemMap);
-        delete newItemMetaMap[item.id];
-        delete newItemMap[item.id];
+      store.update(prevState => {
+        const newItemMetaLookup = _extends({}, prevState.items.itemMetaLookup);
+        const newItemModelLookup = _extends({}, prevState.items.itemModelLookup);
+        delete newItemMetaLookup[item.id];
+        delete newItemModelLookup[item.id];
         return _extends({}, prevState, {
           items: _extends({}, prevState.items, {
-            itemMetaMap: newItemMetaMap,
-            itemMap: newItemMap
+            itemMetaLookup: newItemMetaLookup,
+            itemModelLookup: newItemModelLookup
           })
         });
       });
@@ -55,12 +58,12 @@ export const useTreeViewJSXItems = ({
   });
   const setJSXItemsOrderedChildrenIds = (parentId, orderedChildrenIds) => {
     const parentIdWithDefault = parentId ?? TREE_VIEW_ROOT_PARENT_ID;
-    setState(prevState => _extends({}, prevState, {
+    store.update(prevState => _extends({}, prevState, {
       items: _extends({}, prevState.items, {
-        itemOrderedChildrenIds: _extends({}, prevState.items.itemOrderedChildrenIds, {
+        itemOrderedChildrenIdsLookup: _extends({}, prevState.items.itemOrderedChildrenIdsLookup, {
           [parentIdWithDefault]: orderedChildrenIds
         }),
-        itemChildrenIndexes: _extends({}, prevState.items.itemChildrenIndexes, {
+        itemChildrenIndexesLookup: _extends({}, prevState.items.itemChildrenIndexesLookup, {
           [parentIdWithDefault]: buildSiblingIndexes(orderedChildrenIds)
         })
       })
@@ -87,12 +90,6 @@ export const useTreeViewJSXItems = ({
     }
   };
 };
-const isItemExpandable = reactChildren => {
-  if (Array.isArray(reactChildren)) {
-    return reactChildren.length > 0 && reactChildren.some(isItemExpandable);
-  }
-  return Boolean(reactChildren);
-};
 const useTreeViewJSXItemsItemPlugin = ({
   props,
   rootRef,
@@ -100,7 +97,7 @@ const useTreeViewJSXItemsItemPlugin = ({
 }) => {
   const {
     instance,
-    treeId
+    store
   } = useTreeViewContext();
   const {
     children,
@@ -121,6 +118,7 @@ const useTreeViewJSXItemsItemPlugin = ({
   const expandable = isItemExpandable(children);
   const pluginContentRef = React.useRef(null);
   const handleContentRef = useForkRef(pluginContentRef, contentRef);
+  const treeId = useSelector(store, selectorTreeViewId);
 
   // Prevent any flashing
   useEnhancedEffect(() => {
@@ -132,9 +130,10 @@ const useTreeViewJSXItemsItemPlugin = ({
     registerChild(idAttribute, itemId);
     return () => {
       unregisterChild(idAttribute);
+      unregisterChild(idAttribute);
     };
-  }, [registerChild, unregisterChild, itemId, id, treeId]);
-  React.useEffect(() => {
+  }, [store, instance, registerChild, unregisterChild, itemId, id, treeId]);
+  useEnhancedEffect(() => {
     return instance.insertJSXItem({
       id: itemId,
       idAttribute: id,
@@ -157,12 +156,14 @@ const useTreeViewJSXItemsItemPlugin = ({
 useTreeViewJSXItems.itemPlugin = useTreeViewJSXItemsItemPlugin;
 useTreeViewJSXItems.wrapItem = ({
   children,
-  itemId
+  itemId,
+  idAttribute
 }) => {
   // eslint-disable-next-line react-hooks/rules-of-hooks
   const depthContext = React.useContext(TreeViewItemDepthContext);
   return /*#__PURE__*/_jsx(TreeViewChildrenItemProvider, {
     itemId: itemId,
+    idAttribute: idAttribute,
     children: /*#__PURE__*/_jsx(TreeViewItemDepthContext.Provider, {
       value: depthContext + 1,
       children: children
@@ -172,6 +173,8 @@ useTreeViewJSXItems.wrapItem = ({
 useTreeViewJSXItems.wrapRoot = ({
   children
 }) => /*#__PURE__*/_jsx(TreeViewChildrenItemProvider, {
+  itemId: null,
+  idAttribute: null,
   children: /*#__PURE__*/_jsx(TreeViewItemDepthContext.Provider, {
     value: 0,
     children: children

package/modern/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js

@@ -4,19 +4,25 @@ import useEventCallback from '@mui/utils/useEventCallback';
 import { getFirstNavigableItem, getLastNavigableItem, getNextNavigableItem, getPreviousNavigableItem, isTargetInDescendants } from "../../utils/tree.js";
 import { hasPlugin } from "../../utils/plugins.js";
 import { useTreeViewLabel } from "../useTreeViewLabel/index.js";
+import { useSelector } from "../../hooks/useSelector.js";
+import { selectorItemMetaLookup, selectorIsItemDisabled, selectorItemParentId } from "../useTreeViewItems/useTreeViewItems.selectors.js";
+import { selectorIsItemBeingEdited, selectorIsItemEditable } from "../useTreeViewLabel/useTreeViewLabel.selectors.js";
+import { selectorIsItemSelected } from "../useTreeViewSelection/useTreeViewSelection.selectors.js";
+import { selectorIsItemExpandable, selectorIsItemExpanded } from "../useTreeViewExpansion/useTreeViewExpansion.selectors.js";
 function isPrintableKey(string) {
   return !!string && string.length === 1 && !!string.match(/\S/);
 }
 export const useTreeViewKeyboardNavigation = ({
   instance,
-  params,
-  state
+  store,
+  params
 }) => {
   const isRtl = useRtl();
   const firstCharMap = React.useRef({});
   const updateFirstCharMap = useEventCallback(callback => {
     firstCharMap.current = callback(firstCharMap.current);
   });
+  const itemMetaLookup = useSelector(store, selectorItemMetaLookup);
   React.useEffect(() => {
     if (instance.areItemUpdatesPrevented()) {
       return;
@@ -25,16 +31,16 @@ export const useTreeViewKeyboardNavigation = ({
     const processItem = item => {
       newFirstCharMap[item.id] = item.label.substring(0, 1).toLowerCase();
     };
-    Object.values(state.items.itemMetaMap).forEach(processItem);
+    Object.values(itemMetaLookup).forEach(processItem);
     firstCharMap.current = newFirstCharMap;
-  }, [state.items.itemMetaMap, params.getItemId, instance]);
+  }, [itemMetaLookup, params.getItemId, instance]);
   const getFirstMatchingItem = (itemId, query) => {
     const cleanQuery = query.toLowerCase();
     const getNextItem = itemIdToCheck => {
-      const nextItemId = getNextNavigableItem(instance, itemIdToCheck);
+      const nextItemId = getNextNavigableItem(store.value, itemIdToCheck);
       // We reached the end of the tree, check from the beginning
       if (nextItemId === null) {
-        return getFirstNavigableItem(instance);
+        return getFirstNavigableItem(store.value);
       }
       return nextItemId;
     };
@@ -52,9 +58,9 @@ export const useTreeViewKeyboardNavigation = ({
     }
     return matchingItemId;
   };
-  const canToggleItemSelection = itemId => !params.disableSelection && !instance.isItemDisabled(itemId);
+  const canToggleItemSelection = itemId => !params.disableSelection && !selectorIsItemDisabled(store.value, itemId);
   const canToggleItemExpansion = itemId => {
-    return !instance.isItemDisabled(itemId) && instance.isItemExpandable(itemId);
+    return !selectorIsItemDisabled(store.value, itemId) && selectorIsItemExpandable(store.value, itemId);
   };
 
   // ARIA specification: https://www.w3.org/WAI/ARIA/apg/patterns/treeview/#keyboardinteraction
@@ -91,7 +97,10 @@ export const useTreeViewKeyboardNavigation = ({
       // If the focused item has no children, we select it.
       case key === 'Enter':
         {
-          if (hasPlugin(instance, useTreeViewLabel) && instance.isItemEditable(itemId) && !instance.isItemBeingEdited(itemId)) {
+          if (hasPlugin(instance, useTreeViewLabel) && selectorIsItemEditable(store.value, {
+            itemId,
+            isItemEditable: params.isItemEditable
+          }) && !selectorIsItemBeingEdited(store.value, itemId)) {
             instance.setEditedItemId(itemId);
           } else if (canToggleItemExpansion(itemId)) {
             instance.toggleItemExpansion(event, itemId);
@@ -104,7 +113,7 @@ export const useTreeViewKeyboardNavigation = ({
                 itemId,
                 keepExistingSelection: true
               });
-            } else if (!instance.isItemSelected(itemId)) {
+            } else if (!selectorIsItemSelected(store.value, itemId)) {
               instance.selectItem({
                 event,
                 itemId
@@ -118,7 +127,7 @@ export const useTreeViewKeyboardNavigation = ({
       // Focus the next focusable item
       case key === 'ArrowDown':
         {
-          const nextItem = getNextNavigableItem(instance, itemId);
+          const nextItem = getNextNavigableItem(store.value, itemId);
           if (nextItem) {
             event.preventDefault();
             instance.focusItem(event, nextItem);
@@ -135,7 +144,7 @@ export const useTreeViewKeyboardNavigation = ({
       // Focuses the previous focusable item
       case key === 'ArrowUp':
         {
-          const previousItem = getPreviousNavigableItem(instance, itemId);
+          const previousItem = getPreviousNavigableItem(store.value, itemId);
           if (previousItem) {
             event.preventDefault();
             instance.focusItem(event, previousItem);
@@ -156,8 +165,8 @@ export const useTreeViewKeyboardNavigation = ({
           if (ctrlPressed) {
             return;
           }
-          if (instance.isItemExpanded(itemId)) {
-            const nextItemId = getNextNavigableItem(instance, itemId);
+          if (selectorIsItemExpanded(store.value, itemId)) {
+            const nextItemId = getNextNavigableItem(store.value, itemId);
             if (nextItemId) {
               instance.focusItem(event, nextItemId);
               event.preventDefault();
@@ -176,11 +185,11 @@ export const useTreeViewKeyboardNavigation = ({
           if (ctrlPressed) {
             return;
           }
-          if (canToggleItemExpansion(itemId) && instance.isItemExpanded(itemId)) {
+          if (canToggleItemExpansion(itemId) && selectorIsItemExpanded(store.value, itemId)) {
             instance.toggleItemExpansion(event, itemId);
             event.preventDefault();
           } else {
-            const parent = instance.getItemMeta(itemId).parentId;
+            const parent = selectorItemParentId(store.value, itemId);
             if (parent) {
               instance.focusItem(event, parent);
               event.preventDefault();
@@ -197,7 +206,7 @@ export const useTreeViewKeyboardNavigation = ({
           if (canToggleItemSelection(itemId) && params.multiSelect && ctrlPressed && event.shiftKey) {
             instance.selectRangeFromStartToItem(event, itemId);
           } else {
-            instance.focusItem(event, getFirstNavigableItem(instance));
+            instance.focusItem(event, getFirstNavigableItem(store.value));
           }
           event.preventDefault();
           break;
@@ -211,7 +220,7 @@ export const useTreeViewKeyboardNavigation = ({
           if (canToggleItemSelection(itemId) && params.multiSelect && ctrlPressed && event.shiftKey) {
             instance.selectRangeFromItemToEnd(event, itemId);
           } else {
-            instance.focusItem(event, getLastNavigableItem(instance));
+            instance.focusItem(event, getLastNavigableItem(store.value));
           }
           event.preventDefault();
           break;

package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.itemPlugin.js

@@ -1,29 +1,37 @@
 import * as React from 'react';
 import { useTreeViewContext } from "../../TreeViewProvider/index.js";
+import { useSelector } from "../../hooks/useSelector.js";
+import { selectorIsItemBeingEdited, selectorIsItemEditable } from "./useTreeViewLabel.selectors.js";
 export const useTreeViewLabelItemPlugin = ({
   props
 }) => {
   const {
-    instance
+    store,
+    label: {
+      isItemEditable
+    }
   } = useTreeViewContext();
   const {
     label,
     itemId
   } = props;
   const [labelInputValue, setLabelInputValue] = React.useState(label);
-  const isItemBeingEdited = instance.isItemBeingEdited(itemId);
+  const editable = useSelector(store, selectorIsItemEditable, {
+    itemId,
+    isItemEditable
+  });
+  const editing = useSelector(store, selectorIsItemBeingEdited, itemId);
   React.useEffect(() => {
-    if (!isItemBeingEdited) {
+    if (!editing) {
       setLabelInputValue(label);
     }
-  }, [isItemBeingEdited, label]);
+  }, [editing, label]);
   return {
     propsEnhancers: {
       labelInput: ({
         externalEventHandlers,
         interactions
       }) => {
-        const editable = instance.isItemEditable(itemId);
         if (!editable) {
           return {};
         }

package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.js

@@ -3,41 +3,26 @@ import * as React from 'react';
 import { warnOnce } from '@mui/x-internals/warning';
 import { useTreeViewLabelItemPlugin } from "./useTreeViewLabel.itemPlugin.js";
 export const useTreeViewLabel = ({
-  instance,
-  state,
-  setState,
+  store,
   params
 }) => {
-  const editedItemRef = React.useRef(state.editedItemId);
-  const isItemBeingEditedRef = itemId => editedItemRef.current === itemId;
   const setEditedItemId = editedItemId => {
-    setState(prevState => _extends({}, prevState, {
-      editedItemId
+    store.update(prevState => _extends({}, prevState, {
+      label: {
+        editedItemId
+      }
     }));
-    editedItemRef.current = editedItemId;
-  };
-  const isItemBeingEdited = itemId => itemId === state.editedItemId;
-  const isTreeViewEditable = Boolean(params.isItemEditable);
-  const isItemEditable = itemId => {
-    if (itemId == null || !isTreeViewEditable) {
-      return false;
-    }
-    const item = instance.getItem(itemId);
-    if (!item) {
-      return false;
-    }
-    return typeof params.isItemEditable === 'function' ? params.isItemEditable(item) : Boolean(params.isItemEditable);
   };
   const updateItemLabel = (itemId, label) => {
     if (!label) {
       throw new Error(['MUI X: The Tree View component requires all items to have a `label` property.', 'The label of an item cannot be empty.', itemId].join('\n'));
     }
-    setState(prevState => {
-      const item = prevState.items.itemMetaMap[itemId];
+    store.update(prevState => {
+      const item = prevState.items.itemMetaLookup[itemId];
       if (item.label !== label) {
         return _extends({}, prevState, {
           items: _extends({}, prevState.items, {
-            itemMetaMap: _extends({}, prevState.items.itemMetaMap, {
+            itemMetaLookup: _extends({}, prevState.items.itemMetaLookup, {
               [itemId]: _extends({}, item, {
                 label
               })
@@ -51,18 +36,20 @@ export const useTreeViewLabel = ({
       params.onItemLabelChange(itemId, label);
     }
   };
+  const pluginContextValue = React.useMemo(() => ({
+    label: {
+      isItemEditable: params.isItemEditable
+    }
+  }), [params.isItemEditable]);
   return {
     instance: {
       setEditedItemId,
-      isItemBeingEdited,
-      updateItemLabel,
-      isItemEditable,
-      isTreeViewEditable,
-      isItemBeingEditedRef
+      updateItemLabel
     },
     publicAPI: {
       updateItemLabel
-    }
+    },
+    contextValue: pluginContextValue
   };
 };
 useTreeViewLabel.itemPlugin = useTreeViewLabelItemPlugin;
@@ -81,7 +68,9 @@ useTreeViewLabel.getDefaultizedParams = ({
   });
 };
 useTreeViewLabel.getInitialState = () => ({
-  editedItemId: null
+  label: {
+    editedItemId: null
+  }
 });
 useTreeViewLabel.params = {
   onItemLabelChange: true,

package/modern/internals/plugins/useTreeViewLabel/useTreeViewLabel.selectors.js

@@ -0,0 +1,26 @@
+import { createSelector } from "../../utils/selectors.js";
+import { selectorItemModel } from "../useTreeViewItems/useTreeViewItems.selectors.js";
+const selectorTreeViewLabelState = state => state.label;
+
+/**
+ * Check if an item is editable.
+ * @param {TreeViewState<[UseTreeViewItemsSignature]>} state The state of the tree view.
+ * @param {object} params The parameters.
+ * @param {TreeViewItemId} params.itemId The id of the item to check.
+ * @param {((item: any) => boolean) | boolean} params.isItemEditable The function to determine if an item is editable.
+ * @returns {boolean} `true` if the item is editable, `false` otherwise.
+ */
+export const selectorIsItemEditable = createSelector([(_, args) => args, (state, args) => selectorItemModel(state, args.itemId)], (args, itemModel) => {
+  if (!itemModel || !args.isItemEditable) {
+    return false;
+  }
+  return typeof args.isItemEditable === 'function' ? args.isItemEditable(itemModel) : true;
+});
+
+/**
+ * Check if an item is being edited.
+ * @param {TreeViewState<[UseTreeViewLabelSignature]>} state The state of the tree view.
+ * @param {TreeViewItemId} itemId The id of the item to check.
+ * @returns {boolean} `true` if the item is being edited, `false` otherwise.
+ */
+export const selectorIsItemBeingEdited = createSelector([selectorTreeViewLabelState, (_, itemId) => itemId], (labelState, itemId) => labelState.editedItemId === itemId);

package/modern/internals/plugins/useTreeViewSelection/useTreeViewSelection.itemPlugin.js

@@ -1,8 +1,10 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import { useTreeViewContext } from "../../TreeViewProvider/index.js";
+import { selectorItemOrderedChildrenIds } from "../useTreeViewItems/useTreeViewItems.selectors.js";
+import { selectorIsItemSelected } from "./useTreeViewSelection.selectors.js";
 function getCheckboxStatus({
   itemId,
-  instance,
+  store,
   selectionPropagation,
   selected
 }) {
@@ -12,7 +14,7 @@ function getCheckboxStatus({
       checked: true
     };
   }
-  const children = instance.getItemOrderedChildrenIds(itemId);
+  const children = selectorItemOrderedChildrenIds(store.value, itemId);
   if (children.length === 0) {
     return {
       indeterminate: false,
@@ -23,13 +25,13 @@ function getCheckboxStatus({
   let hasUnSelectedDescendant = false;
   const traverseDescendants = itemToTraverseId => {
     if (itemToTraverseId !== itemId) {
-      if (instance.isItemSelected(itemToTraverseId)) {
+      if (selectorIsItemSelected(store.value, itemToTraverseId)) {
         hasSelectedDescendant = true;
       } else {
         hasUnSelectedDescendant = true;
       }
     }
-    instance.getItemOrderedChildrenIds(itemToTraverseId).forEach(traverseDescendants);
+    selectorItemOrderedChildrenIds(store.value, itemToTraverseId).forEach(traverseDescendants);
   };
   traverseDescendants(itemId);
   return {
@@ -44,7 +46,7 @@ export const useTreeViewSelectionItemPlugin = ({
     itemId
   } = props;
   const {
-    instance,
+    store,
     selection: {
       disableSelection,
       checkboxSelection,
@@ -69,7 +71,7 @@ export const useTreeViewSelectionItemPlugin = ({
           interactions.handleCheckboxSelection(event);
         };
         const checkboxStatus = getCheckboxStatus({
-          instance,
+          store,
           itemId,
           selectionPropagation,
           selected: status.selected