@mui/x-tree-view 7.0.0-beta.3 → 7.0.0-beta.5

package/modern/internals/useTreeView/useTreeView.js

@@ -3,6 +3,16 @@ import * as React from 'react';
 import useForkRef from '@mui/utils/useForkRef';
 import { useTreeViewModels } from './useTreeViewModels';
 import { TREE_VIEW_CORE_PLUGINS } from '../corePlugins';
+export function useTreeViewApiInitialization(inputApiRef) {
+  const fallbackPublicApiRef = React.useRef({});
+  if (inputApiRef) {
+    if (inputApiRef.current == null) {
+      inputApiRef.current = {};
+    }
+    return inputApiRef.current;
+  }
+  return fallbackPublicApiRef.current;
+}
 export const useTreeView = inParams => {
   const plugins = [...TREE_VIEW_CORE_PLUGINS, ...inParams.plugins];
   const params = plugins.reduce((acc, plugin) => {
@@ -14,6 +24,7 @@ export const useTreeView = inParams => {
   const models = useTreeViewModels(plugins, params);
   const instanceRef = React.useRef({});
   const instance = instanceRef.current;
+  const publicAPI = useTreeViewApiInitialization(inParams.apiRef);
   const innerRootRef = React.useRef(null);
   const handleRootRef = useForkRef(innerRootRef, inParams.rootRef);
   const [state, setState] = React.useState(() => {
@@ -32,6 +43,7 @@ export const useTreeView = inParams => {
   const runPlugin = plugin => {
     const pluginResponse = plugin({
       instance,
+      publicAPI,
       params,
       slots: params.slots,
       slotProps: params.slotProps,

package/modern/internals/useTreeView/useTreeView.utils.js

@@ -40,4 +40,7 @@ export const getLastNode = instance => {
 export const getFirstNode = instance => instance.getNavigableChildrenIds(null)[0];
 export const populateInstance = (instance, methods) => {
   Object.assign(instance, methods);
+};
+export const populatePublicAPI = (publicAPI, methods) => {
+  Object.assign(publicAPI, methods);
 };

package/modern/internals/utils/extractPluginParamsFromProps.js

@@ -1,10 +1,11 @@
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
-const _excluded = ["slots", "slotProps"];
+const _excluded = ["slots", "slotProps", "apiRef"];
 export const extractPluginParamsFromProps = _ref => {
   let {
       props: {
         slots,
-        slotProps
+        slotProps,
+        apiRef
       },
       plugins,
       rootRef
@@ -18,7 +19,8 @@ export const extractPluginParamsFromProps = _ref => {
     plugins,
     rootRef,
     slots: slots ?? {},
-    slotProps: slotProps ?? {}
+    slotProps: slotProps ?? {},
+    apiRef
   };
   const otherProps = {};
   Object.keys(props).forEach(propName => {

package/modern/internals/utils/utils.js

@@ -0,0 +1,10 @@
+export const getActiveElement = (root = document) => {
+  const activeEl = root.activeElement;
+  if (!activeEl) {
+    return null;
+  }
+  if (activeEl.shadowRoot) {
+    return getActiveElement(activeEl.shadowRoot);
+  }
+  return activeEl;
+};

package/node/RichTreeView/RichTreeView.js

@@ -141,6 +141,14 @@ process.env.NODE_ENV !== "production" ? RichTreeView.propTypes = {
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "yarn proptypes"  |
   // ----------------------------------------------------------------------
+  /**
+   * The ref object that allows Tree View manipulation. Can be instantiated with `useTreeViewApiRef()`.
+   */
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.shape({
+      focusNode: _propTypes.default.func.isRequired
+    })
+  }),
   /**
    * Override or extend the styles applied to the component.
    */

package/node/SimpleTreeView/SimpleTreeView.js

@@ -99,6 +99,14 @@ process.env.NODE_ENV !== "production" ? SimpleTreeView.propTypes = {
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "yarn proptypes"  |
   // ----------------------------------------------------------------------
+  /**
+   * The ref object that allows Tree View manipulation. Can be instantiated with `useTreeViewApiRef()`.
+   */
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.shape({
+      focusNode: _propTypes.default.func.isRequired
+    })
+  }),
   /**
    * The content of the component.
    */

package/node/TreeItem/TreeItem.js

@@ -368,7 +368,7 @@ TreeItem.propTypes = {
   TransitionComponent: _propTypes.default.elementType,
   /**
    * Props applied to the transition element.
-   * By default, the element is based on this [`Transition`](http://reactcommunity.org/react-transition-group/transition/) component.
+   * By default, the element is based on this [`Transition`](https://reactcommunity.org/react-transition-group/transition/) component.
    */
   TransitionProps: _propTypes.default.object
 };

package/node/TreeView/TreeView.js

@@ -73,6 +73,14 @@ process.env.NODE_ENV !== "production" ? TreeView.propTypes = {
   // | These PropTypes are generated from the TypeScript type definitions |
   // | To update them edit the TypeScript types and run "yarn proptypes"  |
   // ----------------------------------------------------------------------
+  /**
+   * The ref object that allows Tree View manipulation. Can be instantiated with `useTreeViewApiRef()`.
+   */
+  apiRef: _propTypes.default.shape({
+    current: _propTypes.default.shape({
+      focusNode: _propTypes.default.func.isRequired
+    })
+  }),
   /**
    * The content of the component.
    */

package/node/hooks/index.js

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

package/node/hooks/useTreeViewApiRef.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useTreeViewApiRef = void 0;
+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; }
+/**
+ * Hook that instantiates a [[TreeViewApiRef]].
+ */
+const useTreeViewApiRef = () => React.useRef(undefined);
+exports.useTreeViewApiRef = useTreeViewApiRef;

package/node/index.js

@@ -1,5 +1,5 @@
 /**
- * @mui/x-tree-view v7.0.0-beta.3
+ * @mui/x-tree-view v7.0.0-beta.5
  *
  * @license MIT
  * This source code is licensed under the MIT license found in the
@@ -91,4 +91,16 @@ Object.keys(_icons).forEach(function (key) {
       return _icons[key];
     }
   });
+});
+var _hooks = require("./hooks");
+Object.keys(_hooks).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _hooks[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _hooks[key];
+    }
+  });
 });

package/node/internals/TreeViewProvider/DescendantProvider.js

@@ -16,17 +16,8 @@ const _excluded = ["element"];
 /** Credit: https://github.com/reach/reach-ui/blob/86a046f54d53b6420e392b3fa56dd991d9d4e458/packages/descendants/README.md
  *  Modified slightly to suit our purposes.
  */
-// To replace with .findIndex() once we stop IE11 support.
 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 findIndex(array, comp) {
-  for (let i = 0; i < array.length; i += 1) {
-    if (comp(array[i])) {
-      return i;
-    }
-  }
-  return -1;
-}
 function binaryFindElement(array, element) {
   let start = 0;
   let end = array.length - 1;
@@ -92,7 +83,7 @@ function useDescendant(descendant) {
   // index on the following render, and we will re-register descendants
   // so that everything is up-to-date before the user interacts with a
   // collection.
-  const index = findIndex(descendants, item => item.element === descendant.element);
+  const index = descendants.findIndex(item => item.element === descendant.element);
   const previousDescendants = usePrevious(descendants);
 
   // We also need to re-register descendants any time ANY of the other

package/node/internals/hooks/useTimeout.js

@@ -1,18 +1,20 @@
 "use strict";
+'use client';
 
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.Timeout = void 0;
 exports.useTimeout = useTimeout;
 var _useLazyRef = require("./useLazyRef");
 var _useOnMount = require("./useOnMount");
 class Timeout {
   constructor() {
-    this.currentId = 0;
+    this.currentId = null;
     this.clear = () => {
-      if (this.currentId !== 0) {
+      if (this.currentId !== null) {
         clearTimeout(this.currentId);
-        this.currentId = 0;
+        this.currentId = null;
       }
     };
     this.disposeEffect = () => {
@@ -22,11 +24,18 @@ class Timeout {
   static create() {
     return new Timeout();
   }
+  /**
+   * Executes `fn` after `delay`, clearing any previously scheduled call.
+   */
   start(delay, fn) {
     this.clear();
-    this.currentId = setTimeout(fn, delay);
+    this.currentId = setTimeout(() => {
+      this.currentId = null;
+      fn();
+    }, delay);
   }
 }
+exports.Timeout = Timeout;
 function useTimeout() {
   const timeout = (0, _useLazyRef.useLazyRef)(Timeout.create).current;
   (0, _useOnMount.useOnMount)(timeout.disposeEffect);

package/node/internals/plugins/useTreeViewFocus/useTreeViewFocus.js

@@ -11,10 +11,12 @@ var _useEventCallback = _interopRequireDefault(require("@mui/utils/useEventCallb
 var _ownerDocument = _interopRequireDefault(require("@mui/utils/ownerDocument"));
 var _useTreeView = require("../../useTreeView/useTreeView.utils");
 var _useInstanceEventHandler = require("../../hooks/useInstanceEventHandler");
+var _utils = require("../../utils/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; }
 const useTreeViewFocus = ({
   instance,
+  publicAPI,
   params,
   state,
   setState,
@@ -23,19 +25,45 @@ const useTreeViewFocus = ({
 }) => {
   const setFocusedNodeId = (0, _useEventCallback.default)(nodeId => {
     const cleanNodeId = typeof nodeId === 'function' ? nodeId(state.focusedNodeId) : nodeId;
-    setState(prevState => (0, _extends2.default)({}, prevState, {
-      focusedNodeId: cleanNodeId
-    }));
+    if (state.focusedNodeId !== cleanNodeId) {
+      setState(prevState => (0, _extends2.default)({}, prevState, {
+        focusedNodeId: cleanNodeId
+      }));
+    }
   });
-  const isNodeFocused = React.useCallback(nodeId => state.focusedNodeId === nodeId, [state.focusedNodeId]);
+  const isTreeViewFocused = React.useCallback(() => !!rootRef.current && rootRef.current === (0, _utils.getActiveElement)((0, _ownerDocument.default)(rootRef.current)), [rootRef]);
+  const isNodeFocused = React.useCallback(nodeId => state.focusedNodeId === nodeId && isTreeViewFocused(), [state.focusedNodeId, isTreeViewFocused]);
+  const isNodeVisible = nodeId => {
+    const node = instance.getNode(nodeId);
+    return node && (node.parentId == null || instance.isNodeExpanded(node.parentId));
+  };
   const focusNode = (0, _useEventCallback.default)((event, nodeId) => {
-    if (nodeId) {
+    // if we receive a nodeId, and it is visible, the focus will be set to it
+    if (nodeId && isNodeVisible(nodeId)) {
+      if (!isTreeViewFocused()) {
+        instance.focusRoot();
+      }
       setFocusedNodeId(nodeId);
       if (params.onNodeFocus) {
         params.onNodeFocus(event, nodeId);
       }
     }
   });
+  const focusDefaultNode = (0, _useEventCallback.default)(event => {
+    let nodeToFocusId;
+    if (Array.isArray(models.selectedNodes.value)) {
+      nodeToFocusId = models.selectedNodes.value.find(isNodeVisible);
+    } else if (models.selectedNodes.value != null && isNodeVisible(models.selectedNodes.value)) {
+      nodeToFocusId = models.selectedNodes.value;
+    }
+    if (nodeToFocusId == null) {
+      nodeToFocusId = instance.getNavigableChildrenIds(null)[0];
+    }
+    setFocusedNodeId(nodeToFocusId);
+    if (params.onNodeFocus) {
+      params.onNodeFocus(event, nodeToFocusId);
+    }
+  });
   const focusRoot = (0, _useEventCallback.default)(() => {
     rootRef.current?.focus({
       preventScroll: true
@@ -44,7 +72,11 @@ const useTreeViewFocus = ({
   (0, _useTreeView.populateInstance)(instance, {
     isNodeFocused,
     focusNode,
-    focusRoot
+    focusRoot,
+    focusDefaultNode
+  });
+  (0, _useTreeView.populatePublicAPI)(publicAPI, {
+    focusNode
   });
   (0, _useInstanceEventHandler.useInstanceEventHandler)(instance, 'removeNode', ({
     id
@@ -58,23 +90,9 @@ const useTreeViewFocus = ({
   });
   const createHandleFocus = otherHandlers => event => {
     otherHandlers.onFocus?.(event);
-
     // if the event bubbled (which is React specific) we don't want to steal focus
     if (event.target === event.currentTarget) {
-      const isNodeVisible = nodeId => {
-        const node = instance.getNode(nodeId);
-        return node && (node.parentId == null || instance.isNodeExpanded(node.parentId));
-      };
-      let nodeToFocusId;
-      if (Array.isArray(models.selectedNodes.value)) {
-        nodeToFocusId = models.selectedNodes.value.find(isNodeVisible);
-      } else if (models.selectedNodes.value != null && isNodeVisible(models.selectedNodes.value)) {
-        nodeToFocusId = models.selectedNodes.value;
-      }
-      if (nodeToFocusId == null) {
-        nodeToFocusId = instance.getNavigableChildrenIds(null)[0];
-      }
-      instance.focusNode(event, nodeToFocusId);
+      instance.focusDefaultNode(event);
     }
   };
   const createHandleBlur = otherHandlers => event => {

package/node/internals/useTreeView/useTreeView.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.useTreeView = void 0;
+exports.useTreeViewApiInitialization = useTreeViewApiInitialization;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var React = _interopRequireWildcard(require("react"));
 var _useForkRef = _interopRequireDefault(require("@mui/utils/useForkRef"));
@@ -12,6 +13,16 @@ 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 useTreeViewApiInitialization(inputApiRef) {
+  const fallbackPublicApiRef = React.useRef({});
+  if (inputApiRef) {
+    if (inputApiRef.current == null) {
+      inputApiRef.current = {};
+    }
+    return inputApiRef.current;
+  }
+  return fallbackPublicApiRef.current;
+}
 const useTreeView = inParams => {
   const plugins = [..._corePlugins.TREE_VIEW_CORE_PLUGINS, ...inParams.plugins];
   const params = plugins.reduce((acc, plugin) => {
@@ -23,6 +34,7 @@ const useTreeView = inParams => {
   const models = (0, _useTreeViewModels.useTreeViewModels)(plugins, params);
   const instanceRef = React.useRef({});
   const instance = instanceRef.current;
+  const publicAPI = useTreeViewApiInitialization(inParams.apiRef);
   const innerRootRef = React.useRef(null);
   const handleRootRef = (0, _useForkRef.default)(innerRootRef, inParams.rootRef);
   const [state, setState] = React.useState(() => {
@@ -41,6 +53,7 @@ const useTreeView = inParams => {
   const runPlugin = plugin => {
     const pluginResponse = plugin({
       instance,
+      publicAPI,
       params,
       slots: params.slots,
       slotProps: params.slotProps,

package/node/internals/useTreeView/useTreeView.utils.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.populateInstance = exports.getPreviousNode = exports.getNextNode = exports.getLastNode = exports.getFirstNode = void 0;
+exports.populatePublicAPI = exports.populateInstance = exports.getPreviousNode = exports.getNextNode = exports.getLastNode = exports.getFirstNode = void 0;
 const getPreviousNode = (instance, nodeId) => {
   const node = instance.getNode(nodeId);
   const siblings = instance.getNavigableChildrenIds(node.parentId);
@@ -51,4 +51,8 @@ exports.getFirstNode = getFirstNode;
 const populateInstance = (instance, methods) => {
   Object.assign(instance, methods);
 };
-exports.populateInstance = populateInstance;
+exports.populateInstance = populateInstance;
+const populatePublicAPI = (publicAPI, methods) => {
+  Object.assign(publicAPI, methods);
+};
+exports.populatePublicAPI = populatePublicAPI;

package/node/internals/utils/extractPluginParamsFromProps.js

@@ -6,12 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.extractPluginParamsFromProps = void 0;
 var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
-const _excluded = ["slots", "slotProps"];
+const _excluded = ["slots", "slotProps", "apiRef"];
 const extractPluginParamsFromProps = _ref => {
   let {
       props: {
         slots,
-        slotProps
+        slotProps,
+        apiRef
       },
       plugins,
       rootRef
@@ -25,7 +26,8 @@ const extractPluginParamsFromProps = _ref => {
     plugins,
     rootRef,
     slots: slots ?? {},
-    slotProps: slotProps ?? {}
+    slotProps: slotProps ?? {},
+    apiRef
   };
   const otherProps = {};
   Object.keys(props).forEach(propName => {

package/node/internals/utils/utils.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getActiveElement = void 0;
+const getActiveElement = (root = document) => {
+  const activeEl = root.activeElement;
+  if (!activeEl) {
+    return null;
+  }
+  if (activeEl.shadowRoot) {
+    return getActiveElement(activeEl.shadowRoot);
+  }
+  return activeEl;
+};
+exports.getActiveElement = getActiveElement;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mui/x-tree-view",
-  "version": "7.0.0-beta.3",
+  "version": "7.0.0-beta.5",
   "description": "The community edition of the tree view components (MUI X).",
   "author": "MUI Team",
   "main": "./node/index.js",