@mui/x-tree-view 7.22.1 → 8.0.0-alpha.1

package/node/internals/useTreeView/useTreeView.js

@@ -14,6 +14,7 @@ var _useTreeViewModels = require("./useTreeViewModels");
 var _corePlugins = require("../corePlugins");
 var _extractPluginParamsFromProps = require("./extractPluginParamsFromProps");
 var _useTreeViewBuildContext = require("./useTreeViewBuildContext");
+var _TreeViewStore = require("../utils/TreeViewStore");
 function useTreeViewApiInitialization(inputApiRef) {
   const fallbackPublicApiRef = React.useRef({});
   if (inputApiRef) {
@@ -24,12 +25,13 @@ function useTreeViewApiInitialization(inputApiRef) {
   }
   return fallbackPublicApiRef.current;
 }
+let globalId = 0;
 const useTreeView = ({
   plugins: inPlugins,
   rootRef,
   props
 }) => {
-  const plugins = [..._corePlugins.TREE_VIEW_CORE_PLUGINS, ...inPlugins];
+  const plugins = React.useMemo(() => [..._corePlugins.TREE_VIEW_CORE_PLUGINS, ...inPlugins], [inPlugins]);
   const {
     pluginParams,
     forwardedProps,
@@ -47,22 +49,30 @@ const useTreeView = ({
   const publicAPI = useTreeViewApiInitialization(apiRef);
   const innerRootRef = React.useRef(null);
   const handleRootRef = (0, _useForkRef.default)(innerRootRef, rootRef);
-  const contextValue = (0, _useTreeViewBuildContext.useTreeViewBuildContext)({
-    plugins,
-    instance,
-    publicAPI,
-    rootRef: innerRootRef
-  });
-  const [state, setState] = React.useState(() => {
-    const temp = {};
+  const storeRef = React.useRef(null);
+  if (storeRef.current == null) {
+    globalId += 1;
+    const initialState = {
+      cacheKey: {
+        id: globalId
+      }
+    };
     plugins.forEach(plugin => {
       if (plugin.getInitialState) {
-        Object.assign(temp, plugin.getInitialState(pluginParams));
+        Object.assign(initialState, plugin.getInitialState(pluginParams));
       }
     });
-    return temp;
+    storeRef.current = new _TreeViewStore.TreeViewStore(initialState);
+  }
+  const baseContextValue = (0, _useTreeViewBuildContext.useTreeViewBuildContext)({
+    plugins,
+    instance,
+    publicAPI,
+    store: storeRef.current,
+    rootRef: innerRootRef
   });
   const rootPropsGetters = [];
+  const pluginContextValues = [];
   const runPlugin = plugin => {
     const pluginResponse = plugin({
       instance,
@@ -70,11 +80,10 @@ const useTreeView = ({
       slots,
       slotProps,
       experimentalFeatures,
-      state,
-      setState,
       rootRef: innerRootRef,
       models,
-      plugins
+      plugins,
+      store: storeRef.current
     });
     if (pluginResponse.getRootProps) {
       rootPropsGetters.push(pluginResponse.getRootProps);
@@ -86,7 +95,7 @@ const useTreeView = ({
       Object.assign(instance, pluginResponse.instance);
     }
     if (pluginResponse.contextValue) {
-      Object.assign(contextValue, pluginResponse.contextValue);
+      pluginContextValues.push(pluginResponse.contextValue);
     }
   };
   plugins.forEach(runPlugin);
@@ -101,11 +110,15 @@ const useTreeView = ({
     });
     return rootProps;
   };
+  const contextValue = React.useMemo(() => {
+    const copiedBaseContextValue = (0, _extends2.default)({}, baseContextValue);
+    return Object.assign(copiedBaseContextValue, ...pluginContextValues);
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [baseContextValue, ...pluginContextValues]);
   return {
     getRootProps,
     rootRef: handleRootRef,
-    contextValue,
-    instance
+    contextValue
   };
 };
 exports.useTreeView = useTreeView;

package/node/internals/useTreeView/useTreeViewBuildContext.js

@@ -1,16 +1,19 @@
 "use strict";
 
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useTreeViewBuildContext = void 0;
+var React = _interopRequireWildcard(require("react"));
 const useTreeViewBuildContext = ({
   plugins,
   instance,
   publicAPI,
+  store,
   rootRef
 }) => {
-  const runItemPlugins = itemPluginProps => {
+  const runItemPlugins = React.useCallback(itemPluginProps => {
     let finalRootRef = null;
     let finalContentRef = null;
     const pluginPropEnhancers = [];
@@ -55,10 +58,11 @@ const useTreeViewBuildContext = ({
       rootRef: finalRootRef,
       propsEnhancers
     };
-  };
-  const wrapItem = ({
+  }, [plugins]);
+  const wrapItem = React.useCallback(({
     itemId,
-    children
+    children,
+    idAttribute
   }) => {
     let finalChildren = children;
     // The wrappers are reversed to ensure that the first wrapper is the outermost one.
@@ -66,15 +70,16 @@ const useTreeViewBuildContext = ({
       const plugin = plugins[i];
       if (plugin.wrapItem) {
         finalChildren = plugin.wrapItem({
+          instance,
           itemId,
           children: finalChildren,
-          instance
+          idAttribute
         });
       }
     }
     return finalChildren;
-  };
-  const wrapRoot = ({
+  }, [plugins, instance]);
+  const wrapRoot = React.useCallback(({
     children
   }) => {
     let finalChildren = children;
@@ -83,20 +88,22 @@ const useTreeViewBuildContext = ({
       const plugin = plugins[i];
       if (plugin.wrapRoot) {
         finalChildren = plugin.wrapRoot({
-          children: finalChildren,
-          instance
+          children: finalChildren
         });
       }
     }
     return finalChildren;
-  };
-  return {
-    runItemPlugins,
-    wrapItem,
-    wrapRoot,
-    instance,
-    rootRef,
-    publicAPI
-  };
+  }, [plugins]);
+  return React.useMemo(() => {
+    return {
+      runItemPlugins,
+      wrapItem,
+      wrapRoot,
+      instance,
+      publicAPI,
+      store,
+      rootRef
+    };
+  }, [runItemPlugins, wrapItem, wrapRoot, instance, publicAPI, store, rootRef]);
 };
 exports.useTreeViewBuildContext = useTreeViewBuildContext;

package/node/internals/utils/TreeViewStore.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TreeViewStore = void 0;
+class TreeViewStore {
+  constructor(value) {
+    this.value = void 0;
+    this.listeners = void 0;
+    this.subscribe = fn => {
+      this.listeners.add(fn);
+      return () => {
+        this.listeners.delete(fn);
+      };
+    };
+    this.getSnapshot = () => {
+      return this.value;
+    };
+    this.update = updater => {
+      const newState = updater(this.value);
+      if (newState !== this.value) {
+        this.value = newState;
+        this.listeners.forEach(l => l(newState));
+      }
+    };
+    this.value = value;
+    this.listeners = new Set();
+  }
+}
+exports.TreeViewStore = TreeViewStore;

package/node/internals/utils/selectors.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createSelector = void 0;
+var _reselect = require("reselect");
+const reselectCreateSelector = (0, _reselect.createSelectorCreator)({
+  memoize: _reselect.lruMemoize,
+  memoizeOptions: {
+    maxSize: 1,
+    equalityCheck: Object.is
+  }
+});
+const cache = new WeakMap();
+/**
+ * Method wrapping reselect's createSelector to provide caching for tree view instances.
+ *
+ */
+const createSelector = (...createSelectorArgs) => {
+  const selector = (state, selectorArgs) => {
+    const cacheKey = state.cacheKey;
+
+    // If there is no cache for the current tree view instance, create one.
+    let cacheForCurrentTreeViewInstance = cache.get(cacheKey);
+    if (!cacheForCurrentTreeViewInstance) {
+      cacheForCurrentTreeViewInstance = new Map();
+      cache.set(cacheKey, cacheForCurrentTreeViewInstance);
+    }
+
+    // If there is a cached selector, execute it.
+    const cachedSelector = cacheForCurrentTreeViewInstance.get(createSelectorArgs);
+    if (cachedSelector) {
+      return cachedSelector(state, selectorArgs);
+    }
+
+    // Otherwise, create a new selector and cache it and execute it.
+    const fn = reselectCreateSelector(...createSelectorArgs);
+    cacheForCurrentTreeViewInstance.set(createSelectorArgs, fn);
+    return fn(state, selectorArgs);
+  };
+  return selector;
+};
+exports.createSelector = createSelector;

package/node/internals/utils/tree.js

@@ -4,10 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.isTargetInDescendants = exports.getPreviousNavigableItem = exports.getNonDisabledItemsInRange = exports.getNextNavigableItem = exports.getLastNavigableItem = exports.getFirstNavigableItem = exports.getAllNavigableItems = exports.findOrderInTremauxTree = void 0;
-const getLastNavigableItemInArray = (instance, items) => {
+var _useTreeViewExpansion = require("../plugins/useTreeViewExpansion/useTreeViewExpansion.selectors");
+var _useTreeViewItems = require("../plugins/useTreeViewItems/useTreeViewItems.selectors");
+const getLastNavigableItemInArray = (state, items) => {
   // Equivalent to Array.prototype.findLastIndex
   let itemIndex = items.length - 1;
-  while (itemIndex >= 0 && !instance.isItemNavigable(items[itemIndex])) {
+  while (itemIndex >= 0 && !(0, _useTreeViewItems.selectorCanItemBeFocused)(state, items[itemIndex])) {
     itemIndex -= 1;
   }
   if (itemIndex === -1) {
@@ -15,10 +17,13 @@ const getLastNavigableItemInArray = (instance, items) => {
   }
   return items[itemIndex];
 };
-const getPreviousNavigableItem = (instance, itemId) => {
-  const itemMeta = instance.getItemMeta(itemId);
-  const siblings = instance.getItemOrderedChildrenIds(itemMeta.parentId);
-  const itemIndex = instance.getItemIndex(itemId);
+const getPreviousNavigableItem = (state, itemId) => {
+  const itemMeta = (0, _useTreeViewItems.selectorItemMeta)(state, itemId);
+  if (!itemMeta) {
+    return null;
+  }
+  const siblings = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemMeta.parentId);
+  const itemIndex = (0, _useTreeViewItems.selectorItemIndex)(state, itemId);
 
   // TODO: What should we do if the parent is not navigable?
   if (itemIndex === 0) {
@@ -27,7 +32,7 @@ const getPreviousNavigableItem = (instance, itemId) => {
 
   // Finds the previous navigable sibling.
   let previousNavigableSiblingIndex = itemIndex - 1;
-  while (!instance.isItemNavigable(siblings[previousNavigableSiblingIndex]) && previousNavigableSiblingIndex >= 0) {
+  while (!(0, _useTreeViewItems.selectorCanItemBeFocused)(state, siblings[previousNavigableSiblingIndex]) && previousNavigableSiblingIndex >= 0) {
     previousNavigableSiblingIndex -= 1;
   }
   if (previousNavigableSiblingIndex === -1) {
@@ -37,53 +42,53 @@ const getPreviousNavigableItem = (instance, itemId) => {
     }
 
     // Otherwise, we can try to go up a level and find the previous navigable item.
-    return getPreviousNavigableItem(instance, itemMeta.parentId);
+    return getPreviousNavigableItem(state, itemMeta.parentId);
   }
 
   // Finds the last navigable ancestor of the previous navigable sibling.
   let currentItemId = siblings[previousNavigableSiblingIndex];
-  let lastNavigableChild = getLastNavigableItemInArray(instance, instance.getItemOrderedChildrenIds(currentItemId));
-  while (instance.isItemExpanded(currentItemId) && lastNavigableChild != null) {
+  let lastNavigableChild = getLastNavigableItemInArray(state, (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, currentItemId));
+  while ((0, _useTreeViewExpansion.selectorIsItemExpanded)(state, currentItemId) && lastNavigableChild != null) {
     currentItemId = lastNavigableChild;
-    lastNavigableChild = instance.getItemOrderedChildrenIds(currentItemId).find(instance.isItemNavigable);
+    lastNavigableChild = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, currentItemId).find(childId => (0, _useTreeViewItems.selectorCanItemBeFocused)(state, childId));
   }
   return currentItemId;
 };
 exports.getPreviousNavigableItem = getPreviousNavigableItem;
-const getNextNavigableItem = (instance, itemId) => {
+const getNextNavigableItem = (state, itemId) => {
   // If the item is expanded and has some navigable children, return the first of them.
-  if (instance.isItemExpanded(itemId)) {
-    const firstNavigableChild = instance.getItemOrderedChildrenIds(itemId).find(instance.isItemNavigable);
+  if ((0, _useTreeViewExpansion.selectorIsItemExpanded)(state, itemId)) {
+    const firstNavigableChild = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemId).find(childId => (0, _useTreeViewItems.selectorCanItemBeFocused)(state, childId));
     if (firstNavigableChild != null) {
       return firstNavigableChild;
     }
   }
-  let itemMeta = instance.getItemMeta(itemId);
+  let itemMeta = (0, _useTreeViewItems.selectorItemMeta)(state, 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);
+    const siblings = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemMeta.parentId);
+    const currentItemIndex = (0, _useTreeViewItems.selectorItemIndex)(state, itemMeta.id);
     if (currentItemIndex < siblings.length - 1) {
       let nextItemIndex = currentItemIndex + 1;
-      while (!instance.isItemNavigable(siblings[nextItemIndex]) && nextItemIndex < siblings.length - 1) {
+      while (!(0, _useTreeViewItems.selectorCanItemBeFocused)(state, siblings[nextItemIndex]) && nextItemIndex < siblings.length - 1) {
         nextItemIndex += 1;
       }
-      if (instance.isItemNavigable(siblings[nextItemIndex])) {
+      if ((0, _useTreeViewItems.selectorCanItemBeFocused)(state, siblings[nextItemIndex])) {
         return siblings[nextItemIndex];
       }
     }
 
     // If the sibling does not exist, go up a level to the parent and try again.
-    itemMeta = instance.getItemMeta(itemMeta.parentId);
+    itemMeta = (0, _useTreeViewItems.selectorItemMeta)(state, itemMeta.parentId);
   }
   return null;
 };
 exports.getNextNavigableItem = getNextNavigableItem;
-const getLastNavigableItem = instance => {
+const getLastNavigableItem = state => {
   let itemId = null;
-  while (itemId == null || instance.isItemExpanded(itemId)) {
-    const children = instance.getItemOrderedChildrenIds(itemId);
-    const lastNavigableChild = getLastNavigableItemInArray(instance, children);
+  while (itemId == null || (0, _useTreeViewExpansion.selectorIsItemExpanded)(state, itemId)) {
+    const children = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemId);
+    const lastNavigableChild = getLastNavigableItemInArray(state, children);
 
     // The item has no navigable children.
     if (lastNavigableChild == null) {
@@ -94,7 +99,7 @@ const getLastNavigableItem = instance => {
   return itemId;
 };
 exports.getLastNavigableItem = getLastNavigableItem;
-const getFirstNavigableItem = instance => instance.getItemOrderedChildrenIds(null).find(instance.isItemNavigable);
+const getFirstNavigableItem = state => (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, null).find(itemId => (0, _useTreeViewItems.selectorCanItemBeFocused)(state, itemId));
 
 /**
  * This is used to determine the start and end of a selection range so
@@ -111,12 +116,15 @@ const getFirstNavigableItem = instance => instance.getItemOrderedChildrenIds(nul
  * https://en.wikipedia.org/wiki/Tr%C3%A9maux_tree
  */
 exports.getFirstNavigableItem = getFirstNavigableItem;
-const findOrderInTremauxTree = (instance, itemAId, itemBId) => {
+const findOrderInTremauxTree = (state, itemAId, itemBId) => {
   if (itemAId === itemBId) {
     return [itemAId, itemBId];
   }
-  const itemMetaA = instance.getItemMeta(itemAId);
-  const itemMetaB = instance.getItemMeta(itemBId);
+  const itemMetaA = (0, _useTreeViewItems.selectorItemMeta)(state, itemAId);
+  const itemMetaB = (0, _useTreeViewItems.selectorItemMeta)(state, itemBId);
+  if (!itemMetaA || !itemMetaB) {
+    return [itemAId, itemBId];
+  }
   if (itemMetaA.parentId === itemMetaB.id || itemMetaB.parentId === itemMetaA.id) {
     return itemMetaB.parentId === itemMetaA.id ? [itemMetaA.id, itemMetaB.id] : [itemMetaB.id, itemMetaA.id];
   }
@@ -134,7 +142,7 @@ const findOrderInTremauxTree = (instance, itemAId, itemBId) => {
       aAncestorIsCommon = bFamily.indexOf(aAncestor) !== -1;
       continueA = aAncestor !== null;
       if (!aAncestorIsCommon && continueA) {
-        aAncestor = instance.getItemMeta(aAncestor).parentId;
+        aAncestor = (0, _useTreeViewItems.selectorItemParentId)(state, aAncestor);
       }
     }
     if (continueB && !aAncestorIsCommon) {
@@ -142,55 +150,55 @@ const findOrderInTremauxTree = (instance, itemAId, itemBId) => {
       bAncestorIsCommon = aFamily.indexOf(bAncestor) !== -1;
       continueB = bAncestor !== null;
       if (!bAncestorIsCommon && continueB) {
-        bAncestor = instance.getItemMeta(bAncestor).parentId;
+        bAncestor = (0, _useTreeViewItems.selectorItemParentId)(state, bAncestor);
       }
     }
   }
   const commonAncestor = aAncestorIsCommon ? aAncestor : bAncestor;
-  const ancestorFamily = instance.getItemOrderedChildrenIds(commonAncestor);
+  const ancestorFamily = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, commonAncestor);
   const aSide = aFamily[aFamily.indexOf(commonAncestor) - 1];
   const bSide = bFamily[bFamily.indexOf(commonAncestor) - 1];
   return ancestorFamily.indexOf(aSide) < ancestorFamily.indexOf(bSide) ? [itemAId, itemBId] : [itemBId, itemAId];
 };
 exports.findOrderInTremauxTree = findOrderInTremauxTree;
-const getNonDisabledItemsInRange = (instance, itemAId, itemBId) => {
+const getNonDisabledItemsInRange = (state, 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];
+    if ((0, _useTreeViewExpansion.selectorIsItemExpandable)(state, itemId) && (0, _useTreeViewExpansion.selectorIsItemExpanded)(state, itemId)) {
+      return (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemId)[0];
     }
-    let itemMeta = instance.getItemMeta(itemId);
+    let itemMeta = (0, _useTreeViewItems.selectorItemMeta)(state, 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);
+      const siblings = (0, _useTreeViewItems.selectorItemOrderedChildrenIds)(state, itemMeta.parentId);
+      const currentItemIndex = (0, _useTreeViewItems.selectorItemIndex)(state, 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);
+      itemMeta = itemMeta.parentId ? (0, _useTreeViewItems.selectorItemMeta)(state, itemMeta.parentId) : null;
     }
     throw new Error('Invalid range');
   };
-  const [first, last] = findOrderInTremauxTree(instance, itemAId, itemBId);
+  const [first, last] = findOrderInTremauxTree(state, itemAId, itemBId);
   const items = [first];
   let current = first;
   while (current !== last) {
     current = getNextItem(current);
-    if (!instance.isItemDisabled(current)) {
+    if (!(0, _useTreeViewItems.selectorIsItemDisabled)(state, current)) {
       items.push(current);
     }
   }
   return items;
 };
 exports.getNonDisabledItemsInRange = getNonDisabledItemsInRange;
-const getAllNavigableItems = instance => {
-  let item = getFirstNavigableItem(instance);
+const getAllNavigableItems = state => {
+  let item = getFirstNavigableItem(state);
   const navigableItems = [];
   while (item != null) {
     navigableItems.push(item);
-    item = getNextNavigableItem(instance, item);
+    item = getNextNavigableItem(state, item);
   }
   return navigableItems;
 };

package/node/useTreeItem/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "useTreeItem", {
+  enumerable: true,
+  get: function () {
+    return _useTreeItem.useTreeItem;
+  }
+});
+var _useTreeItem = require("./useTreeItem");