@mui/x-tree-view 7.0.0-beta.6 → 7.0.0

package/internals/plugins/useTreeViewKeyboardNavigation/useTreeViewKeyboardNavigation.js

@@ -15,8 +15,7 @@ function findNextFirstChar(firstChars, startIndex, char) {
 }
 export const useTreeViewKeyboardNavigation = ({
   instance,
-  params,
-  state
+  params
 }) => {
   const theme = useTheme();
   const isRTL = theme.direction === 'rtl';
@@ -32,37 +31,33 @@ export const useTreeViewKeyboardNavigation = ({
     }
     const newFirstCharMap = {};
     const processItem = item => {
-      var _item$children;
       const getItemId = params.getItemId;
-      const nodeId = getItemId ? getItemId(item) : item.id;
-      newFirstCharMap[nodeId] = instance.getNode(nodeId).label.substring(0, 1).toLowerCase();
-      (_item$children = item.children) == null || _item$children.forEach(processItem);
+      const itemId = getItemId ? getItemId(item) : item.id;
+      newFirstCharMap[itemId] = instance.getNode(itemId).label.substring(0, 1).toLowerCase();
+      item.children?.forEach(processItem);
     };
     params.items.forEach(processItem);
     firstCharMap.current = newFirstCharMap;
   }, [params.items, params.getItemId, instance]);
-  populateInstance(instance, {
-    updateFirstCharMap
-  });
-  const getFirstMatchingNode = (nodeId, firstChar) => {
+  const getFirstMatchingItem = (itemId, firstChar) => {
     let start;
     let index;
     const lowercaseChar = firstChar.toLowerCase();
     const firstCharIds = [];
     const firstChars = [];
     // This really only works since the ids are strings
-    Object.keys(firstCharMap.current).forEach(mapNodeId => {
-      const map = instance.getNode(mapNodeId);
+    Object.keys(firstCharMap.current).forEach(mapItemId => {
+      const map = instance.getNode(mapItemId);
       const visible = map.parentId ? instance.isNodeExpanded(map.parentId) : true;
-      const shouldBeSkipped = params.disabledItemsFocusable ? false : instance.isNodeDisabled(mapNodeId);
+      const shouldBeSkipped = params.disabledItemsFocusable ? false : instance.isNodeDisabled(mapItemId);
       if (visible && !shouldBeSkipped) {
-        firstCharIds.push(mapNodeId);
-        firstChars.push(firstCharMap.current[mapNodeId]);
+        firstCharIds.push(mapItemId);
+        firstChars.push(firstCharMap.current[mapItemId]);
       }
     });
 
     // Get start index for search based on position of currentItem
-    start = firstCharIds.indexOf(nodeId) + 1;
+    start = firstCharIds.indexOf(itemId) + 1;
     if (start >= firstCharIds.length) {
       start = 0;
     }
@@ -81,19 +76,17 @@ export const useTreeViewKeyboardNavigation = ({
     }
     return null;
   };
-  const canToggleNodeSelection = nodeId => !params.disableSelection && !instance.isNodeDisabled(nodeId);
-  const canToggleNodeExpansion = nodeId => !instance.isNodeDisabled(nodeId) && instance.isNodeExpandable(nodeId);
+  const canToggleItemSelection = itemId => !params.disableSelection && !instance.isNodeDisabled(itemId);
+  const canToggleItemExpansion = itemId => {
+    return !instance.isNodeDisabled(itemId) && instance.isNodeExpandable(itemId);
+  };
 
   // ARIA specification: https://www.w3.org/WAI/ARIA/apg/patterns/treeview/#keyboardinteraction
-  const createHandleKeyDown = otherHandlers => event => {
-    var _otherHandlers$onKeyD;
-    (_otherHandlers$onKeyD = otherHandlers.onKeyDown) == null || _otherHandlers$onKeyD.call(otherHandlers, event);
+  const handleItemKeyDown = (event, itemId) => {
     if (event.defaultMuiPrevented) {
       return;
     }
-
-    // If the tree is empty there will be no focused node
-    if (event.altKey || event.currentTarget !== event.target || state.focusedNodeId == null) {
+    if (event.altKey || event.currentTarget !== event.target) {
       return;
     }
     const ctrlPressed = event.ctrlKey || event.metaKey;
@@ -102,17 +95,17 @@ export const useTreeViewKeyboardNavigation = ({
     // eslint-disable-next-line default-case
     switch (true) {
       // Select the node when pressing "Space"
-      case key === ' ' && canToggleNodeSelection(state.focusedNodeId):
+      case key === ' ' && canToggleItemSelection(itemId):
         {
           event.preventDefault();
           if (params.multiSelect && event.shiftKey) {
             instance.selectRange(event, {
-              end: state.focusedNodeId
+              end: itemId
             });
           } else if (params.multiSelect) {
-            instance.selectNode(event, state.focusedNodeId, true);
+            instance.selectNode(event, itemId, true);
           } else {
-            instance.selectNode(event, state.focusedNodeId);
+            instance.selectNode(event, itemId);
           }
           break;
         }
@@ -121,86 +114,89 @@ export const useTreeViewKeyboardNavigation = ({
       // If the focused node has no children, we select it.
       case key === 'Enter':
         {
-          if (canToggleNodeExpansion(state.focusedNodeId)) {
-            instance.toggleNodeExpansion(event, state.focusedNodeId);
+          if (canToggleItemExpansion(itemId)) {
+            instance.toggleNodeExpansion(event, itemId);
             event.preventDefault();
-          } else if (canToggleNodeSelection(state.focusedNodeId)) {
+          } else if (canToggleItemSelection(itemId)) {
             if (params.multiSelect) {
               event.preventDefault();
-              instance.selectNode(event, state.focusedNodeId, true);
-            } else if (!instance.isNodeSelected(state.focusedNodeId)) {
-              instance.selectNode(event, state.focusedNodeId);
+              instance.selectNode(event, itemId, true);
+            } else if (!instance.isNodeSelected(itemId)) {
+              instance.selectNode(event, itemId);
               event.preventDefault();
             }
           }
           break;
         }
 
-      // Focus the next focusable node
+      // Focus the next focusable item
       case key === 'ArrowDown':
         {
-          const nextNode = getNextNode(instance, state.focusedNodeId);
-          if (nextNode) {
+          const nextItem = getNextNode(instance, itemId);
+          if (nextItem) {
             event.preventDefault();
-            instance.focusNode(event, nextNode);
+            instance.focusItem(event, nextItem);
 
             // Multi select behavior when pressing Shift + ArrowDown
-            // Toggles the selection state of the next node
-            if (params.multiSelect && event.shiftKey && canToggleNodeSelection(nextNode)) {
+            // Toggles the selection state of the next item
+            if (params.multiSelect && event.shiftKey && canToggleItemSelection(nextItem)) {
               instance.selectRange(event, {
-                end: nextNode,
-                current: state.focusedNodeId
+                end: nextItem,
+                current: itemId
               }, true);
             }
           }
           break;
         }
 
-      // Focuses the previous focusable node
+      // Focuses the previous focusable item
       case key === 'ArrowUp':
         {
-          const previousNode = getPreviousNode(instance, state.focusedNodeId);
-          if (previousNode) {
+          const previousItem = getPreviousNode(instance, itemId);
+          if (previousItem) {
             event.preventDefault();
-            instance.focusNode(event, previousNode);
+            instance.focusItem(event, previousItem);
 
             // Multi select behavior when pressing Shift + ArrowUp
-            // Toggles the selection state of the previous node
-            if (params.multiSelect && event.shiftKey && canToggleNodeSelection(previousNode)) {
+            // Toggles the selection state of the previous item
+            if (params.multiSelect && event.shiftKey && canToggleItemSelection(previousItem)) {
               instance.selectRange(event, {
-                end: previousNode,
-                current: state.focusedNodeId
+                end: previousItem,
+                current: itemId
               }, true);
             }
           }
           break;
         }
 
-      // If the focused node is expanded, we move the focus to its first child
-      // If the focused node is collapsed and has children, we expand it
+      // If the focused item is expanded, we move the focus to its first child
+      // If the focused item is collapsed and has children, we expand it
       case key === 'ArrowRight' && !isRTL || key === 'ArrowLeft' && isRTL:
         {
-          if (instance.isNodeExpanded(state.focusedNodeId)) {
-            instance.focusNode(event, getNextNode(instance, state.focusedNodeId));
-            event.preventDefault();
-          } else if (canToggleNodeExpansion(state.focusedNodeId)) {
-            instance.toggleNodeExpansion(event, state.focusedNodeId);
+          if (instance.isNodeExpanded(itemId)) {
+            const nextNodeId = getNextNode(instance, itemId);
+            if (nextNodeId) {
+              instance.focusItem(event, nextNodeId);
+              event.preventDefault();
+            }
+          } else if (canToggleItemExpansion(itemId)) {
+            instance.toggleNodeExpansion(event, itemId);
             event.preventDefault();
           }
           break;
         }
 
-      // If the focused node is expanded, we collapse it
-      // If the focused node is collapsed and has a parent, we move the focus to this parent
+      // If the focused item is expanded, we collapse it
+      // If the focused item is collapsed and has a parent, we move the focus to this parent
       case key === 'ArrowLeft' && !isRTL || key === 'ArrowRight' && isRTL:
         {
-          if (canToggleNodeExpansion(state.focusedNodeId) && instance.isNodeExpanded(state.focusedNodeId)) {
-            instance.toggleNodeExpansion(event, state.focusedNodeId);
+          if (canToggleItemExpansion(itemId) && instance.isNodeExpanded(itemId)) {
+            instance.toggleNodeExpansion(event, itemId);
             event.preventDefault();
           } else {
-            const parent = instance.getNode(state.focusedNodeId).parentId;
+            const parent = instance.getNode(itemId).parentId;
             if (parent) {
-              instance.focusNode(event, parent);
+              instance.focusItem(event, parent);
               event.preventDefault();
             }
           }
@@ -210,35 +206,35 @@ export const useTreeViewKeyboardNavigation = ({
       // Focuses the first node in the tree
       case key === 'Home':
         {
-          instance.focusNode(event, getFirstNode(instance));
+          instance.focusItem(event, getFirstNode(instance));
 
           // Multi select behavior when pressing Ctrl + Shift + Home
           // Selects the focused node and all nodes up to the first node.
-          if (canToggleNodeSelection(state.focusedNodeId) && params.multiSelect && ctrlPressed && event.shiftKey) {
-            instance.rangeSelectToFirst(event, state.focusedNodeId);
+          if (canToggleItemSelection(itemId) && params.multiSelect && ctrlPressed && event.shiftKey) {
+            instance.rangeSelectToFirst(event, itemId);
           }
           event.preventDefault();
           break;
         }
 
-      // Focuses the last node in the tree
+      // Focuses the last item in the tree
       case key === 'End':
         {
-          instance.focusNode(event, getLastNode(instance));
+          instance.focusItem(event, getLastNode(instance));
 
           // Multi select behavior when pressing Ctrl + Shirt + End
-          // Selects the focused node and all the nodes down to the last node.
-          if (canToggleNodeSelection(state.focusedNodeId) && params.multiSelect && ctrlPressed && event.shiftKey) {
-            instance.rangeSelectToLast(event, state.focusedNodeId);
+          // Selects the focused item and all the items down to the last item.
+          if (canToggleItemSelection(itemId) && params.multiSelect && ctrlPressed && event.shiftKey) {
+            instance.rangeSelectToLast(event, itemId);
           }
           event.preventDefault();
           break;
         }
 
-      // Expand all siblings that are at the same level as the focused node
+      // Expand all siblings that are at the same level as the focused item
       case key === '*':
         {
-          instance.expandAllSiblings(event, state.focusedNodeId);
+          instance.expandAllSiblings(event, itemId);
           event.preventDefault();
           break;
         }
@@ -259,19 +255,18 @@ export const useTreeViewKeyboardNavigation = ({
       // TODO: Support typing multiple characters
       case !ctrlPressed && !event.shiftKey && isPrintableCharacter(key):
         {
-          const matchingNode = getFirstMatchingNode(state.focusedNodeId, key);
+          const matchingNode = getFirstMatchingItem(itemId, key);
           if (matchingNode != null) {
-            instance.focusNode(event, matchingNode);
+            instance.focusItem(event, matchingNode);
             event.preventDefault();
           }
           break;
         }
     }
   };
-  return {
-    getRootProps: otherHandlers => ({
-      onKeyDown: createHandleKeyDown(otherHandlers)
-    })
-  };
+  populateInstance(instance, {
+    updateFirstCharMap,
+    handleItemKeyDown
+  });
 };
 useTreeViewKeyboardNavigation.params = {};

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

@@ -1,10 +1,13 @@
+import * as React from 'react';
 import { TreeViewPluginSignature } from '../../models';
 import { UseTreeViewNodesSignature } from '../useTreeViewNodes';
 import { UseTreeViewSelectionSignature } from '../useTreeViewSelection';
 import { UseTreeViewFocusSignature } from '../useTreeViewFocus';
 import { UseTreeViewExpansionSignature } from '../useTreeViewExpansion';
+import { MuiCancellableEvent } from '../../models/MuiCancellableEvent';
 export interface UseTreeViewKeyboardNavigationInstance {
     updateFirstCharMap: (updater: (map: TreeViewFirstCharMap) => TreeViewFirstCharMap) => void;
+    handleItemKeyDown: (event: React.KeyboardEvent<HTMLElement> & MuiCancellableEvent, itemId: string) => void;
 }
 export type UseTreeViewKeyboardNavigationSignature = TreeViewPluginSignature<{
     instance: UseTreeViewKeyboardNavigationInstance;
@@ -16,5 +19,5 @@ export type UseTreeViewKeyboardNavigationSignature = TreeViewPluginSignature<{
     ];
 }>;
 export type TreeViewFirstCharMap = {
-    [nodeId: string]: string;
+    [itemId: string]: string;
 };

package/internals/plugins/useTreeViewNodes/useTreeViewNodes.js

@@ -1,6 +1,5 @@
 import _extends from "@babel/runtime/helpers/esm/extends";
 import * as React from 'react';
-import useEventCallback from '@mui/utils/useEventCallback';
 import { populateInstance, populatePublicAPI } from '../../useTreeView/useTreeView.utils';
 import { publishTreeViewEvent } from '../../utils/publishTreeViewEvent';
 const updateNodesState = ({
@@ -12,7 +11,6 @@ const updateNodesState = ({
   const nodeMap = {};
   const itemMap = {};
   const processItem = (item, index, parentId) => {
-    var _item$children, _item$children2;
     const id = getItemId ? getItemId(item) : item.id;
     if (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.', 'An item was provided without id in the `items` prop:', JSON.stringify(item)].join('\n'));
@@ -30,13 +28,13 @@ const updateNodesState = ({
       index,
       parentId,
       idAttribute: undefined,
-      expandable: !!((_item$children = item.children) != null && _item$children.length),
+      expandable: !!item.children?.length,
       disabled: isItemDisabled ? isItemDisabled(item) : false
     };
     itemMap[id] = item;
     return {
       id,
-      children: (_item$children2 = item.children) == null ? void 0 : _item$children2.map((child, childIndex) => processItem(child, childIndex, id))
+      children: item.children?.map((child, childIndex) => processItem(child, childIndex, id))
     };
   };
   const nodeTree = items.map((item, itemIndex) => processItem(item, itemIndex, null));
@@ -53,34 +51,34 @@ export const useTreeViewNodes = ({
   state,
   setState
 }) => {
-  const getNode = React.useCallback(nodeId => state.nodes.nodeMap[nodeId], [state.nodes.nodeMap]);
-  const getItem = React.useCallback(nodeId => state.nodes.itemMap[nodeId], [state.nodes.itemMap]);
-  const isNodeDisabled = React.useCallback(nodeId => {
-    if (nodeId == null) {
+  const getNode = React.useCallback(itemId => state.nodes.nodeMap[itemId], [state.nodes.nodeMap]);
+  const getItem = React.useCallback(itemId => state.nodes.itemMap[itemId], [state.nodes.itemMap]);
+  const isNodeDisabled = React.useCallback(itemId => {
+    if (itemId == null) {
       return false;
     }
-    let node = instance.getNode(nodeId);
+    let item = instance.getNode(itemId);
 
-    // This can be called before the node has been added to the node map.
-    if (!node) {
+    // This can be called before the item has been added to the node map.
+    if (!item) {
       return false;
     }
-    if (node.disabled) {
+    if (item.disabled) {
       return true;
     }
-    while (node.parentId != null) {
-      node = instance.getNode(node.parentId);
-      if (node.disabled) {
+    while (item.parentId != null) {
+      item = instance.getNode(item.parentId);
+      if (item.disabled) {
         return true;
       }
     }
     return false;
   }, [instance]);
-  const getChildrenIds = useEventCallback(nodeId => Object.values(state.nodes.nodeMap).filter(node => node.parentId === nodeId).sort((a, b) => a.index - b.index).map(child => child.id));
-  const getNavigableChildrenIds = nodeId => {
-    let childrenIds = instance.getChildrenIds(nodeId);
+  const getChildrenIds = React.useCallback(itemId => Object.values(state.nodes.nodeMap).filter(item => item.parentId === itemId).sort((a, b) => a.index - b.index).map(child => child.id), [state.nodes.nodeMap]);
+  const getNavigableChildrenIds = itemId => {
+    let childrenIds = instance.getChildrenIds(itemId);
     if (!params.disabledItemsFocusable) {
-      childrenIds = childrenIds.filter(node => !instance.isNodeDisabled(node));
+      childrenIds = childrenIds.filter(item => !instance.isNodeDisabled(item));
     }
     return childrenIds;
   };
@@ -104,21 +102,21 @@ export const useTreeViewNodes = ({
       });
     });
   }, [instance, setState, params.items, params.isItemDisabled, params.getItemId, params.getItemLabel]);
-  const getNodesToRender = useEventCallback(() => {
-    const getPropsFromNodeId = ({
+  const getNodesToRender = () => {
+    const getPropsFromItemId = ({
       id,
       children
     }) => {
       const node = state.nodes.nodeMap[id];
       return {
         label: node.label,
-        nodeId: node.id,
+        itemId: node.id,
         id: node.idAttribute,
-        children: children == null ? void 0 : children.map(getPropsFromNodeId)
+        children: children?.map(getPropsFromItemId)
       };
     };
-    return state.nodes.nodeTree.map(getPropsFromNodeId);
-  });
+    return state.nodes.nodeTree.map(getPropsFromItemId);
+  };
   populateInstance(instance, {
     getNode,
     getItem,
@@ -144,12 +142,9 @@ useTreeViewNodes.getInitialState = params => ({
     getItemLabel: params.getItemLabel
   })
 });
-useTreeViewNodes.getDefaultizedParams = params => {
-  var _params$disabledItems;
-  return _extends({}, params, {
-    disabledItemsFocusable: (_params$disabledItems = params.disabledItemsFocusable) != null ? _params$disabledItems : false
-  });
-};
+useTreeViewNodes.getDefaultizedParams = params => _extends({}, params, {
+  disabledItemsFocusable: params.disabledItemsFocusable ?? false
+});
 useTreeViewNodes.params = {
   disabledItemsFocusable: true,
   items: true,

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

@@ -2,17 +2,17 @@ import { TreeViewNode, DefaultizedProps, TreeViewPluginSignature } from '../../m
 import { TreeViewItemId } from '../../../models';
 interface TreeViewNodeProps {
     label: string;
-    nodeId: string;
+    itemId: string;
     id: string | undefined;
     children?: TreeViewNodeProps[];
 }
 export interface UseTreeViewNodesInstance<R extends {}> {
-    getNode: (nodeId: string) => TreeViewNode;
-    getItem: (nodeId: string) => R;
+    getNode: (itemId: string) => TreeViewNode;
+    getItem: (itemId: string) => R;
     getNodesToRender: () => TreeViewNodeProps[];
-    getChildrenIds: (nodeId: string | null) => string[];
-    getNavigableChildrenIds: (nodeId: string | null) => string[];
-    isNodeDisabled: (nodeId: string | null) => nodeId is string;
+    getChildrenIds: (itemId: string | null) => string[];
+    getNavigableChildrenIds: (itemId: string | null) => string[];
+    isNodeDisabled: (itemId: string | null) => itemId is string;
 }
 export interface UseTreeViewNodesPublicAPI<R extends {}> extends Pick<UseTreeViewNodesInstance<R>, 'getItem'> {
 }
@@ -57,13 +57,13 @@ interface UseTreeViewNodesEventLookup {
         };
     };
 }
-export interface TreeViewNodeIdAndChildren {
+export interface TreeViewItemIdAndChildren {
     id: TreeViewItemId;
-    children?: TreeViewNodeIdAndChildren[];
+    children?: TreeViewItemIdAndChildren[];
 }
 export interface UseTreeViewNodesState<R extends {}> {
     nodes: {
-        nodeTree: TreeViewNodeIdAndChildren[];
+        nodeTree: TreeViewItemIdAndChildren[];
         nodeMap: TreeViewNodeMap;
         itemMap: TreeViewItemMap<R>;
     };
@@ -80,9 +80,9 @@ export type UseTreeViewNodesSignature = TreeViewPluginSignature<{
     contextValue: UseTreeViewNodesContextValue;
 }>;
 export type TreeViewNodeMap = {
-    [nodeId: string]: TreeViewNode;
+    [itemId: string]: TreeViewNode;
 };
 export type TreeViewItemMap<R extends {}> = {
-    [nodeId: string]: R;
+    [itemId: string]: R;
 };
 export {};