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

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

@@ -10,49 +10,49 @@ export const useTreeViewSelection = ({
   const lastSelectedNode = React.useRef(null);
   const lastSelectionWasRange = React.useRef(false);
   const currentRangeSelection = React.useRef([]);
-  const setSelectedNodes = (event, newSelectedNodes) => {
-    if (params.onNodeSelectionToggle) {
+  const setSelectedItems = (event, newSelectedItems) => {
+    if (params.onItemSelectionToggle) {
       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);
+        const addedItems = newSelectedItems.filter(itemId => !instance.isNodeSelected(itemId));
+        const removedItems = models.selectedItems.value.filter(itemId => !newSelectedItems.includes(itemId));
+        addedItems.forEach(itemId => {
+          params.onItemSelectionToggle(event, itemId, true);
         });
-        removedNodes.forEach(nodeId => {
-          params.onNodeSelectionToggle(event, nodeId, false);
+        removedItems.forEach(itemId => {
+          params.onItemSelectionToggle(event, itemId, false);
         });
-      } else if (newSelectedNodes !== models.selectedNodes.value) {
-        if (models.selectedNodes.value != null) {
-          params.onNodeSelectionToggle(event, models.selectedNodes.value, false);
+      } else if (newSelectedItems !== models.selectedItems.value) {
+        if (models.selectedItems.value != null) {
+          params.onItemSelectionToggle(event, models.selectedItems.value, false);
         }
-        if (newSelectedNodes != null) {
-          params.onNodeSelectionToggle(event, newSelectedNodes, true);
+        if (newSelectedItems != null) {
+          params.onItemSelectionToggle(event, newSelectedItems, true);
         }
       }
     }
-    if (params.onSelectedNodesChange) {
-      params.onSelectedNodesChange(event, newSelectedNodes);
+    if (params.onSelectedItemsChange) {
+      params.onSelectedItemsChange(event, newSelectedItems);
     }
-    models.selectedNodes.setControlledValue(newSelectedNodes);
+    models.selectedItems.setControlledValue(newSelectedItems);
   };
-  const isNodeSelected = nodeId => Array.isArray(models.selectedNodes.value) ? models.selectedNodes.value.indexOf(nodeId) !== -1 : models.selectedNodes.value === nodeId;
+  const isNodeSelected = nodeId => Array.isArray(models.selectedItems.value) ? models.selectedItems.value.indexOf(nodeId) !== -1 : models.selectedItems.value === nodeId;
   const selectNode = (event, nodeId, multiple = false) => {
     if (params.disableSelection) {
       return;
     }
     if (multiple) {
-      if (Array.isArray(models.selectedNodes.value)) {
+      if (Array.isArray(models.selectedItems.value)) {
         let newSelected;
-        if (models.selectedNodes.value.indexOf(nodeId) !== -1) {
-          newSelected = models.selectedNodes.value.filter(id => id !== nodeId);
+        if (models.selectedItems.value.indexOf(nodeId) !== -1) {
+          newSelected = models.selectedItems.value.filter(id => id !== nodeId);
         } else {
-          newSelected = [nodeId].concat(models.selectedNodes.value);
+          newSelected = [nodeId].concat(models.selectedItems.value);
         }
-        setSelectedNodes(event, newSelected);
+        setSelectedItems(event, newSelected);
       }
     } else {
       const newSelected = params.multiSelect ? [nodeId] : nodeId;
-      setSelectedNodes(event, newSelected);
+      setSelectedItems(event, newSelected);
     }
     lastSelectedNode.current = nodeId;
     lastSelectionWasRange.current = false;
@@ -69,7 +69,7 @@ export const useTreeViewSelection = ({
     return nodes;
   };
   const handleRangeArrowSelect = (event, nodes) => {
-    let base = models.selectedNodes.value.slice();
+    let base = models.selectedItems.value.slice();
     const {
       start,
       next,
@@ -93,10 +93,10 @@ export const useTreeViewSelection = ({
       base.push(next);
       currentRangeSelection.current.push(current, next);
     }
-    setSelectedNodes(event, base);
+    setSelectedItems(event, base);
   };
   const handleRangeSelect = (event, nodes) => {
-    let base = models.selectedNodes.value.slice();
+    let base = models.selectedItems.value.slice();
     const {
       start,
       end
@@ -110,7 +110,7 @@ export const useTreeViewSelection = ({
     currentRangeSelection.current = range;
     let newSelected = base.concat(range);
     newSelected = newSelected.filter((id, i) => newSelected.indexOf(id) === i);
-    setSelectedNodes(event, newSelected);
+    setSelectedItems(event, newSelected);
   };
   const selectRange = (event, nodes, stacked = false) => {
     if (params.disableSelection) {
@@ -174,21 +174,21 @@ export const useTreeViewSelection = ({
   };
 };
 useTreeViewSelection.models = {
-  selectedNodes: {
-    getDefaultValue: params => params.defaultSelectedNodes
+  selectedItems: {
+    getDefaultValue: params => params.defaultSelectedItems
   }
 };
 const DEFAULT_SELECTED_NODES = [];
 useTreeViewSelection.getDefaultizedParams = params => _extends({}, params, {
   disableSelection: params.disableSelection ?? false,
   multiSelect: params.multiSelect ?? false,
-  defaultSelectedNodes: params.defaultSelectedNodes ?? (params.multiSelect ? DEFAULT_SELECTED_NODES : null)
+  defaultSelectedItems: params.defaultSelectedItems ?? (params.multiSelect ? DEFAULT_SELECTED_NODES : null)
 });
 useTreeViewSelection.params = {
   disableSelection: true,
   multiSelect: true,
-  defaultSelectedNodes: true,
-  selectedNodes: true,
-  onSelectedNodesChange: true,
-  onNodeSelectionToggle: true
+  defaultSelectedItems: true,
+  selectedItems: true,
+  onSelectedItemsChange: true,
+  onItemSelectionToggle: true
 };

package/modern/internals/useTreeView/useTreeView.js

@@ -38,6 +38,7 @@ export const useTreeView = inParams => {
   });
   const rootPropsGetters = [];
   const contextValue = {
+    publicAPI,
     instance: instance
   };
   const runPlugin = plugin => {
@@ -60,43 +61,44 @@ export const useTreeView = inParams => {
     }
   };
   plugins.forEach(runPlugin);
-  contextValue.runItemPlugins = ({
-    props,
-    ref
-  }) => {
-    let finalProps = props;
-    let finalRef = ref;
-    const itemWrappers = [];
+  contextValue.runItemPlugins = itemPluginProps => {
+    let finalRootRef = null;
+    let finalContentRef = null;
     plugins.forEach(plugin => {
       if (!plugin.itemPlugin) {
         return;
       }
       const itemPluginResponse = plugin.itemPlugin({
-        props: finalProps,
-        ref: finalRef
+        props: itemPluginProps,
+        rootRef: finalRootRef,
+        contentRef: finalContentRef
       });
-      if (itemPluginResponse?.props) {
-        finalProps = itemPluginResponse.props;
-      }
-      if (itemPluginResponse?.ref) {
-        finalRef = itemPluginResponse.ref;
+      if (itemPluginResponse?.rootRef) {
+        finalRootRef = itemPluginResponse.rootRef;
       }
-      if (itemPluginResponse?.wrapItem) {
-        itemWrappers.push(itemPluginResponse.wrapItem);
+      if (itemPluginResponse?.contentRef) {
+        finalContentRef = itemPluginResponse.contentRef;
       }
     });
     return {
-      props: finalProps,
-      ref: finalRef,
-      wrapItem: children => {
-        let finalChildren = children;
-        itemWrappers.forEach(itemWrapper => {
-          finalChildren = itemWrapper(finalChildren);
-        });
-        return finalChildren;
-      }
+      contentRef: finalContentRef,
+      rootRef: finalRootRef
     };
   };
+  const itemWrappers = plugins.map(plugin => plugin.wrapItem).filter(wrapItem => !!wrapItem);
+  contextValue.wrapItem = ({
+    nodeId,
+    children
+  }) => {
+    let finalChildren = children;
+    itemWrappers.forEach(itemWrapper => {
+      finalChildren = itemWrapper({
+        nodeId,
+        children: finalChildren
+      });
+    });
+    return finalChildren;
+  };
   const getRootProps = (otherHandlers = {}) => {
     const rootProps = _extends({
       role: 'tree',

package/modern/useTreeItem2/index.js

@@ -0,0 +1 @@
+export { useTreeItem2 as unstable_useTreeItem2 } from './useTreeItem2';

package/modern/useTreeItem2/useTreeItem2.js

@@ -0,0 +1,135 @@
+import _extends from "@babel/runtime/helpers/esm/extends";
+import { extractEventHandlers } from '@mui/base/utils';
+import useForkRef from '@mui/utils/useForkRef';
+import { useTreeViewContext } from '../internals/TreeViewProvider/useTreeViewContext';
+import { useTreeItem2Utils } from '../hooks/useTreeItem2Utils';
+export const useTreeItem2 = parameters => {
+  const {
+    runItemPlugins,
+    selection: {
+      multiSelect
+    },
+    disabledItemsFocusable,
+    instance,
+    publicAPI
+  } = useTreeViewContext();
+  const {
+    id,
+    nodeId,
+    label,
+    children,
+    rootRef
+  } = parameters;
+  const {
+    rootRef: pluginRootRef,
+    contentRef
+  } = runItemPlugins(parameters);
+  const {
+    interactions,
+    status
+  } = useTreeItem2Utils({
+    nodeId,
+    children
+  });
+  const idAttribute = instance.getTreeItemId(nodeId, id);
+  const handleRootRef = useForkRef(rootRef, pluginRootRef);
+  const createRootHandleFocus = otherHandlers => event => {
+    otherHandlers.onFocus?.(event);
+    if (event.defaultMuiPrevented) {
+      return;
+    }
+
+    // DOM focus stays on the tree which manages focus with aria-activedescendant
+    if (event.target === event.currentTarget) {
+      instance.focusRoot();
+    }
+    const canBeFocused = !status.disabled || disabledItemsFocusable;
+    if (!status.focused && canBeFocused && event.currentTarget === event.target) {
+      instance.focusItem(event, nodeId);
+    }
+  };
+  const createContentHandleClick = otherHandlers => event => {
+    otherHandlers.onClick?.(event);
+    if (event.defaultMuiPrevented) {
+      return;
+    }
+    interactions.handleExpansion(event);
+    interactions.handleSelection(event);
+  };
+  const createContentHandleMouseDown = otherHandlers => event => {
+    otherHandlers.onMouseDown?.(event);
+    if (event.defaultMuiPrevented) {
+      return;
+    }
+
+    // Prevent text selection
+    if (event.shiftKey || event.ctrlKey || event.metaKey || status.disabled) {
+      event.preventDefault();
+    }
+  };
+  const getRootProps = (externalProps = {}) => {
+    const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
+    let ariaSelected;
+    if (multiSelect) {
+      ariaSelected = status.selected;
+    } else if (status.selected) {
+      /* single-selection trees unset aria-selected on un-selected items.
+       *
+       * If the tree does not support multiple selection, aria-selected
+       * is set to true for the selected node and it is not present on any other node in the tree.
+       * Source: https://www.w3.org/WAI/ARIA/apg/patterns/treeview/
+       */
+      ariaSelected = true;
+    }
+    return _extends({}, externalEventHandlers, {
+      ref: handleRootRef,
+      role: 'treeitem',
+      tabIndex: -1,
+      id: idAttribute,
+      'aria-expanded': status.expandable ? status.expanded : undefined,
+      'aria-selected': ariaSelected,
+      'aria-disabled': status.disabled || undefined
+    }, externalProps, {
+      onFocus: createRootHandleFocus(externalEventHandlers)
+    });
+  };
+  const getContentProps = (externalProps = {}) => {
+    const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
+    return _extends({}, externalEventHandlers, externalProps, {
+      ref: contentRef,
+      onClick: createContentHandleClick(externalEventHandlers),
+      onMouseDown: createContentHandleMouseDown(externalEventHandlers),
+      status
+    });
+  };
+  const getLabelProps = (externalProps = {}) => {
+    const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
+    return _extends({}, externalEventHandlers, {
+      children: label
+    }, externalProps);
+  };
+  const getIconContainerProps = (externalProps = {}) => {
+    const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
+    return _extends({}, externalEventHandlers, externalProps);
+  };
+  const getGroupTransitionProps = (externalProps = {}) => {
+    const externalEventHandlers = _extends({}, extractEventHandlers(parameters), extractEventHandlers(externalProps));
+    return _extends({}, externalEventHandlers, {
+      unmountOnExit: true,
+      component: 'ul',
+      role: 'group',
+      in: status.expanded,
+      children
+    }, externalProps);
+  };
+  return {
+    getRootProps,
+    getContentProps,
+    getGroupTransitionProps,
+    getIconContainerProps,
+    getLabelProps,
+    rootRef: handleRootRef,
+    status,
+    publicAPI
+  };
+};

package/modern/useTreeItem2/useTreeItem2.types.js

@@ -0,0 +1 @@
+export {};

package/node/RichTreeView/RichTreeView.js

@@ -146,7 +146,7 @@ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
    */
   apiRef: _propTypes.default.shape({
     current: _propTypes.default.shape({
-      focusNode: _propTypes.default.func.isRequired,
+      focusItem: _propTypes.default.func.isRequired,
       getItem: _propTypes.default.func.isRequired
     })
   }),
@@ -156,17 +156,17 @@ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
   classes: _propTypes.default.object,
   className: _propTypes.default.string,
   /**
-   * Expanded node ids.
+   * Expanded item ids.
    * Used when the item's expansion is not controlled.
    * @default []
    */
-  defaultExpandedNodes: _propTypes.default.arrayOf(_propTypes.default.string),
+  defaultExpandedItems: _propTypes.default.arrayOf(_propTypes.default.string),
   /**
-   * Selected node ids. (Uncontrolled)
+   * Selected item ids. (Uncontrolled)
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    * @default []
    */
-  defaultSelectedNodes: _propTypes.default.any,
+  defaultSelectedItems: _propTypes.default.any,
   /**
    * If `true`, will allow focus on disabled items.
    * @default false
@@ -178,10 +178,10 @@ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
    */
   disableSelection: _propTypes.default.bool,
   /**
-   * Expanded node ids.
+   * Expanded item ids.
    * Used when the item's expansion is controlled.
    */
-  expandedNodes: _propTypes.default.arrayOf(_propTypes.default.string),
+  expandedItems: _propTypes.default.arrayOf(_propTypes.default.string),
   /**
    * Used to determine the string label for a given item.
    *
@@ -221,42 +221,42 @@ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
   /**
    * Callback fired when tree items are expanded/collapsed.
    * @param {React.SyntheticEvent} event The event source of the callback.
-   * @param {array} nodeIds The ids of the expanded nodes.
+   * @param {array} itemIds The ids of the expanded items.
    */
-  onExpandedNodesChange: _propTypes.default.func,
+  onExpandedItemsChange: _propTypes.default.func,
   /**
    * Callback fired when a tree item is expanded or collapsed.
    * @param {React.SyntheticEvent} event The event source of the callback.
-   * @param {array} nodeId The nodeId of the modified node.
-   * @param {array} isExpanded `true` if the node has just been expanded, `false` if it has just been collapsed.
+   * @param {array} itemId The itemId of the modified item.
+   * @param {array} isExpanded `true` if the item has just been expanded, `false` if it has just been collapsed.
    */
-  onNodeExpansionToggle: _propTypes.default.func,
+  onItemExpansionToggle: _propTypes.default.func,
   /**
    * Callback fired when tree items are focused.
    * @param {React.SyntheticEvent} event The event source of the callback **Warning**: This is a generic event not a focus event.
-   * @param {string} nodeId The id of the node focused.
-   * @param {string} value of the focused node.
+   * @param {string} itemId The id of the focused item.
+   * @param {string} value of the focused item.
    */
-  onNodeFocus: _propTypes.default.func,
+  onItemFocus: _propTypes.default.func,
   /**
    * 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.
+   * @param {array} itemId The itemId of the modified item.
+   * @param {array} isSelected `true` if the item has just been selected, `false` if it has just been deselected.
    */
-  onNodeSelectionToggle: _propTypes.default.func,
+  onItemSelectionToggle: _propTypes.default.func,
   /**
    * Callback fired when tree items are selected/deselected.
    * @param {React.SyntheticEvent} event The event source of the callback
-   * @param {string[] | string} nodeIds The ids of the selected nodes.
+   * @param {string[] | string} itemIds The ids of the selected items.
    * When `multiSelect` is `true`, this is an array of strings; when false (default) a string.
    */
-  onSelectedNodesChange: _propTypes.default.func,
+  onSelectedItemsChange: _propTypes.default.func,
   /**
-   * Selected node ids. (Controlled)
+   * Selected item ids. (Controlled)
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    */
-  selectedNodes: _propTypes.default.any,
+  selectedItems: _propTypes.default.any,
   /**
    * The props used for each component slot.
    * @default {}

package/node/SimpleTreeView/SimpleTreeView.js

@@ -104,7 +104,7 @@ process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
    */
   apiRef: _propTypes.default.shape({
     current: _propTypes.default.shape({
-      focusNode: _propTypes.default.func.isRequired,
+      focusItem: _propTypes.default.func.isRequired,
       getItem: _propTypes.default.func.isRequired
     })
   }),
@@ -118,17 +118,17 @@ process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
   classes: _propTypes.default.object,
   className: _propTypes.default.string,
   /**
-   * Expanded node ids.
+   * Expanded item ids.
    * Used when the item's expansion is not controlled.
    * @default []
    */
-  defaultExpandedNodes: _propTypes.default.arrayOf(_propTypes.default.string),
+  defaultExpandedItems: _propTypes.default.arrayOf(_propTypes.default.string),
   /**
-   * Selected node ids. (Uncontrolled)
+   * Selected item ids. (Uncontrolled)
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    * @default []
    */
-  defaultSelectedNodes: _propTypes.default.any,
+  defaultSelectedItems: _propTypes.default.any,
   /**
    * If `true`, will allow focus on disabled items.
    * @default false
@@ -140,10 +140,10 @@ process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
    */
   disableSelection: _propTypes.default.bool,
   /**
-   * Expanded node ids.
+   * Expanded item ids.
    * Used when the item's expansion is controlled.
    */
-  expandedNodes: _propTypes.default.arrayOf(_propTypes.default.string),
+  expandedItems: _propTypes.default.arrayOf(_propTypes.default.string),
   /**
    * This prop is used to help implement the accessibility logic.
    * If you don't provide this prop. It falls back to a randomly generated id.
@@ -157,42 +157,42 @@ process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
   /**
    * Callback fired when tree items are expanded/collapsed.
    * @param {React.SyntheticEvent} event The event source of the callback.
-   * @param {array} nodeIds The ids of the expanded nodes.
+   * @param {array} itemIds The ids of the expanded items.
    */
-  onExpandedNodesChange: _propTypes.default.func,
+  onExpandedItemsChange: _propTypes.default.func,
   /**
    * Callback fired when a tree item is expanded or collapsed.
    * @param {React.SyntheticEvent} event The event source of the callback.
-   * @param {array} nodeId The nodeId of the modified node.
-   * @param {array} isExpanded `true` if the node has just been expanded, `false` if it has just been collapsed.
+   * @param {array} itemId The itemId of the modified item.
+   * @param {array} isExpanded `true` if the item has just been expanded, `false` if it has just been collapsed.
    */
-  onNodeExpansionToggle: _propTypes.default.func,
+  onItemExpansionToggle: _propTypes.default.func,
   /**
    * Callback fired when tree items are focused.
    * @param {React.SyntheticEvent} event The event source of the callback **Warning**: This is a generic event not a focus event.
-   * @param {string} nodeId The id of the node focused.
-   * @param {string} value of the focused node.
+   * @param {string} itemId The id of the focused item.
+   * @param {string} value of the focused item.
    */
-  onNodeFocus: _propTypes.default.func,
+  onItemFocus: _propTypes.default.func,
   /**
    * 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.
+   * @param {array} itemId The itemId of the modified item.
+   * @param {array} isSelected `true` if the item has just been selected, `false` if it has just been deselected.
    */
-  onNodeSelectionToggle: _propTypes.default.func,
+  onItemSelectionToggle: _propTypes.default.func,
   /**
    * Callback fired when tree items are selected/deselected.
    * @param {React.SyntheticEvent} event The event source of the callback
-   * @param {string[] | string} nodeIds The ids of the selected nodes.
+   * @param {string[] | string} itemIds The ids of the selected items.
    * When `multiSelect` is `true`, this is an array of strings; when false (default) a string.
    */
-  onSelectedNodesChange: _propTypes.default.func,
+  onSelectedItemsChange: _propTypes.default.func,
   /**
-   * Selected node ids. (Controlled)
+   * Selected item ids. (Controlled)
    * When `multiSelect` is true this takes an array of strings; when false (default) a string.
    */
-  selectedNodes: _propTypes.default.any,
+  selectedItems: _propTypes.default.any,
   /**
    * The props used for each component slot.
    */