@mui/x-tree-view 7.3.0 → 7.3.1

package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.js

@@ -8,16 +8,27 @@ exports.useTreeViewSelection = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var React = _interopRequireWildcard(require("react"));
 var _tree = require("../../utils/tree");
+var _useTreeViewSelection = require("./useTreeViewSelection.utils");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 const useTreeViewSelection = ({
   instance,
   params,
   models
 }) => {
   const lastSelectedItem = React.useRef(null);
-  const lastSelectionWasRange = React.useRef(false);
-  const currentRangeSelection = React.useRef([]);
+  const lastSelectedRange = React.useRef({});
+  const selectedItemsMap = React.useMemo(() => {
+    const temp = new Map();
+    if (Array.isArray(models.selectedItems.value)) {
+      models.selectedItems.value.forEach(id => {
+        temp.set(id, true);
+      });
+    } else if (models.selectedItems.value != null) {
+      temp.set(models.selectedItems.value, true);
+    }
+    return temp;
+  }, [models.selectedItems.value]);
   const setSelectedItems = (event, newSelectedItems) => {
     if (params.onItemSelectionToggle) {
       if (params.multiSelect) {
@@ -43,115 +54,90 @@ const useTreeViewSelection = ({
     }
     models.selectedItems.setControlledValue(newSelectedItems);
   };
-  const isItemSelected = itemId => Array.isArray(models.selectedItems.value) ? models.selectedItems.value.indexOf(itemId) !== -1 : models.selectedItems.value === itemId;
+  const isItemSelected = itemId => selectedItemsMap.has(itemId);
   const selectItem = (event, itemId, multiple = false) => {
     if (params.disableSelection) {
       return;
     }
+    let newSelected;
     if (multiple) {
-      if (Array.isArray(models.selectedItems.value)) {
-        let newSelected;
-        if (models.selectedItems.value.indexOf(itemId) !== -1) {
-          newSelected = models.selectedItems.value.filter(id => id !== itemId);
-        } else {
-          newSelected = [itemId].concat(models.selectedItems.value);
-        }
-        setSelectedItems(event, newSelected);
+      const cleanSelectedItems = (0, _useTreeViewSelection.convertSelectedItemsToArray)(models.selectedItems.value);
+      if (instance.isItemSelected(itemId)) {
+        newSelected = cleanSelectedItems.filter(id => id !== itemId);
+      } else {
+        newSelected = [itemId].concat(cleanSelectedItems);
       }
     } else {
-      const newSelected = params.multiSelect ? [itemId] : itemId;
-      setSelectedItems(event, newSelected);
+      newSelected = params.multiSelect ? [itemId] : itemId;
     }
+    setSelectedItems(event, newSelected);
     lastSelectedItem.current = itemId;
-    lastSelectionWasRange.current = false;
-    currentRangeSelection.current = [];
+    lastSelectedRange.current = {};
   };
-  const handleRangeArrowSelect = (event, items) => {
-    let base = models.selectedItems.value.slice();
-    const {
-      start,
-      next,
-      current
-    } = items;
-    if (!next || !current) {
+  const selectRange = (event, [start, end]) => {
+    if (params.disableSelection || !params.multiSelect) {
       return;
     }
-    if (currentRangeSelection.current.indexOf(current) === -1) {
-      currentRangeSelection.current = [];
-    }
-    if (lastSelectionWasRange.current) {
-      if (currentRangeSelection.current.indexOf(next) !== -1) {
-        base = base.filter(id => id === start || id !== current);
-        currentRangeSelection.current = currentRangeSelection.current.filter(id => id === start || id !== current);
-      } else {
-        base.push(next);
-        currentRangeSelection.current.push(next);
-      }
-    } else {
-      base.push(next);
-      currentRangeSelection.current.push(current, next);
+    let newSelectedItems = (0, _useTreeViewSelection.convertSelectedItemsToArray)(models.selectedItems.value).slice();
+
+    // If the last selection was a range selection,
+    // remove the items that were part of the last range from the model
+    if (Object.keys(lastSelectedRange.current).length > 0) {
+      newSelectedItems = newSelectedItems.filter(id => !lastSelectedRange.current[id]);
     }
-    setSelectedItems(event, base);
+
+    // Add to the model the items that are part of the new range and not already part of the model.
+    const selectedItemsLookup = (0, _useTreeViewSelection.getLookupFromArray)(newSelectedItems);
+    const range = (0, _tree.getNonDisabledItemsInRange)(instance, start, end);
+    const itemsToAddToModel = range.filter(id => !selectedItemsLookup[id]);
+    newSelectedItems = newSelectedItems.concat(itemsToAddToModel);
+    setSelectedItems(event, newSelectedItems);
+    lastSelectedRange.current = (0, _useTreeViewSelection.getLookupFromArray)(range);
   };
-  const handleRangeSelect = (event, items) => {
-    let base = models.selectedItems.value.slice();
-    const {
-      start,
-      end
-    } = items;
-    // If last selection was a range selection ignore items that were selected.
-    if (lastSelectionWasRange.current) {
-      base = base.filter(id => currentRangeSelection.current.indexOf(id) === -1);
+  const expandSelectionRange = (event, itemId) => {
+    if (lastSelectedItem.current != null) {
+      const [start, end] = (0, _tree.findOrderInTremauxTree)(instance, itemId, lastSelectedItem.current);
+      selectRange(event, [start, end]);
     }
-    let range = (0, _tree.getNavigableItemsInRange)(instance, start, end);
-    range = range.filter(item => !instance.isItemDisabled(item));
-    currentRangeSelection.current = range;
-    let newSelected = base.concat(range);
-    newSelected = newSelected.filter((id, i) => newSelected.indexOf(id) === i);
-    setSelectedItems(event, newSelected);
   };
-  const selectRange = (event, items, stacked = false) => {
-    if (params.disableSelection) {
+  const selectRangeFromStartToItem = (event, itemId) => {
+    selectRange(event, [(0, _tree.getFirstNavigableItem)(instance), itemId]);
+  };
+  const selectRangeFromItemToEnd = (event, itemId) => {
+    selectRange(event, [itemId, (0, _tree.getLastNavigableItem)(instance)]);
+  };
+  const selectAllNavigableItems = event => {
+    if (params.disableSelection || !params.multiSelect) {
       return;
     }
-    const {
-      start = lastSelectedItem.current,
-      end,
-      current
-    } = items;
-    if (stacked) {
-      handleRangeArrowSelect(event, {
-        start,
-        next: end,
-        current
-      });
-    } else if (start != null && end != null) {
-      handleRangeSelect(event, {
-        start,
-        end
-      });
-    }
-    lastSelectionWasRange.current = true;
+    const navigableItems = (0, _tree.getAllNavigableItems)(instance);
+    setSelectedItems(event, navigableItems);
+    lastSelectedRange.current = (0, _useTreeViewSelection.getLookupFromArray)(navigableItems);
   };
-  const rangeSelectToFirst = (event, itemId) => {
-    if (!lastSelectedItem.current) {
-      lastSelectedItem.current = itemId;
+  const selectItemFromArrowNavigation = (event, currentItem, nextItem) => {
+    if (params.disableSelection || !params.multiSelect) {
+      return;
     }
-    const start = lastSelectionWasRange.current ? lastSelectedItem.current : itemId;
-    instance.selectRange(event, {
-      start,
-      end: (0, _tree.getFirstNavigableItem)(instance)
-    });
-  };
-  const rangeSelectToLast = (event, itemId) => {
-    if (!lastSelectedItem.current) {
-      lastSelectedItem.current = itemId;
+    let newSelectedItems = (0, _useTreeViewSelection.convertSelectedItemsToArray)(models.selectedItems.value).slice();
+    if (Object.keys(lastSelectedRange.current).length === 0) {
+      newSelectedItems.push(nextItem);
+      lastSelectedRange.current = {
+        [currentItem]: true,
+        [nextItem]: true
+      };
+    } else {
+      if (!lastSelectedRange.current[currentItem]) {
+        lastSelectedRange.current = {};
+      }
+      if (lastSelectedRange.current[nextItem]) {
+        newSelectedItems = newSelectedItems.filter(id => id !== currentItem);
+        delete lastSelectedRange.current[currentItem];
+      } else {
+        newSelectedItems.push(nextItem);
+        lastSelectedRange.current[nextItem] = true;
+      }
     }
-    const start = lastSelectionWasRange.current ? lastSelectedItem.current : itemId;
-    instance.selectRange(event, {
-      start,
-      end: (0, _tree.getLastNavigableItem)(instance)
-    });
+    setSelectedItems(event, newSelectedItems);
   };
   return {
     getRootProps: () => ({
@@ -160,9 +146,11 @@ const useTreeViewSelection = ({
     instance: {
       isItemSelected,
       selectItem,
-      selectRange,
-      rangeSelectToLast,
-      rangeSelectToFirst
+      selectAllNavigableItems,
+      expandSelectionRange,
+      selectRangeFromStartToItem,
+      selectRangeFromItemToEnd,
+      selectItemFromArrowNavigation
     },
     contextValue: {
       selection: {

package/node/internals/plugins/useTreeViewSelection/useTreeViewSelection.utils.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getLookupFromArray = exports.convertSelectedItemsToArray = void 0;
+/**
+ * Transform the `selectedItems` model to be an array if it was a string or null.
+ * @param {string[] | string | null} model The raw model.
+ * @returns {string[]} The converted model.
+ */
+const convertSelectedItemsToArray = model => {
+  if (Array.isArray(model)) {
+    return model;
+  }
+  if (model != null) {
+    return [model];
+  }
+  return [];
+};
+exports.convertSelectedItemsToArray = convertSelectedItemsToArray;
+const getLookupFromArray = array => {
+  const lookup = {};
+  array.forEach(itemId => {
+    lookup[itemId] = true;
+  });
+  return lookup;
+};
+exports.getLookupFromArray = getLookupFromArray;

package/node/internals/useTreeView/useTreeView.js

@@ -12,7 +12,7 @@ var _useForkRef = _interopRequireDefault(require("@mui/utils/useForkRef"));
 var _useTreeViewModels = require("./useTreeViewModels");
 var _corePlugins = require("../corePlugins");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function useTreeViewApiInitialization(inputApiRef) {
   const fallbackPublicApiRef = React.useRef({});
   if (inputApiRef) {

package/node/internals/useTreeView/useTreeViewModels.js

@@ -8,7 +8,7 @@ exports.useTreeViewModels = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var React = _interopRequireWildcard(require("react"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /**
  * Implements the same behavior as `useControlled` but for several models.
  * The controlled models are never stored in the state and the state is only updated if the model is not controlled.

package/node/internals/utils/tree.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getPreviousNavigableItem = exports.getNextNavigableItem = exports.getNavigableItemsInRange = exports.getLastNavigableItem = exports.getFirstNavigableItem = void 0;
+exports.getPreviousNavigableItem = exports.getNonDisabledItemsInRange = exports.getNextNavigableItem = exports.getLastNavigableItem = exports.getFirstNavigableItem = exports.getAllNavigableItems = exports.findOrderInTremauxTree = void 0;
 const getLastNavigableItemInArray = (instance, items) => {
   // Equivalent to Array.prototype.findLastIndex
   let itemIndex = items.length - 1;
@@ -135,14 +135,46 @@ const findOrderInTremauxTree = (instance, itemAId, itemBId) => {
   const bSide = bFamily[bFamily.indexOf(commonAncestor) - 1];
   return ancestorFamily.indexOf(aSide) < ancestorFamily.indexOf(bSide) ? [itemAId, itemBId] : [itemBId, itemAId];
 };
-const getNavigableItemsInRange = (instance, itemAId, itemBId) => {
+exports.findOrderInTremauxTree = findOrderInTremauxTree;
+const getNonDisabledItemsInRange = (instance, itemAId, itemBId) => {
+  const getNextItem = itemId => {
+    // If the item is expanded and has some children, return the first of them.
+    if (instance.isItemExpandable(itemId) && instance.isItemExpanded(itemId)) {
+      return instance.getItemOrderedChildrenIds(itemId)[0];
+    }
+    let itemMeta = instance.getItemMeta(itemId);
+    while (itemMeta != null) {
+      // Try to find the first navigable sibling after the current item.
+      const siblings = instance.getItemOrderedChildrenIds(itemMeta.parentId);
+      const currentItemIndex = instance.getItemIndex(itemMeta.id);
+      if (currentItemIndex < siblings.length - 1) {
+        return siblings[currentItemIndex + 1];
+      }
+
+      // If the item is the last of its siblings, go up a level to the parent and try again.
+      itemMeta = instance.getItemMeta(itemMeta.parentId);
+    }
+    throw new Error('Invalid range');
+  };
   const [first, last] = findOrderInTremauxTree(instance, itemAId, itemBId);
   const items = [first];
   let current = first;
   while (current !== last) {
-    current = getNextNavigableItem(instance, current);
-    items.push(current);
+    current = getNextItem(current);
+    if (!instance.isItemDisabled(current)) {
+      items.push(current);
+    }
   }
   return items;
 };
-exports.getNavigableItemsInRange = getNavigableItemsInRange;
+exports.getNonDisabledItemsInRange = getNonDisabledItemsInRange;
+const getAllNavigableItems = instance => {
+  let item = getFirstNavigableItem(instance);
+  const navigableItems = [];
+  while (item != null) {
+    navigableItems.push(item);
+    item = getNextNavigableItem(instance, item);
+  }
+  return navigableItems;
+};
+exports.getAllNavigableItems = getAllNavigableItems;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-tree-view",
-  "version": "7.3.0",
+  "version": "7.3.1",
   "description": "The community edition of the Tree View components (MUI X).",
   "author": "MUI Team",
   "main": "./node/index.js",
@@ -15,7 +15,8 @@
   },
   "sideEffects": false,
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "directory": "build"
   },
   "keywords": [
     "react",
@@ -48,9 +49,6 @@
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },
-  "setupFiles": [
-    "<rootDir>/src/setupTests.js"
-  ],
   "engines": {
     "node": ">=14.0.0"
   },