@mui/x-tree-view-pro 8.0.0-alpha.9 → 8.0.0-beta.1

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

@@ -4,138 +4,124 @@ import { TreeViewPluginSignature, UseTreeViewItemsSignature } from '@mui/x-tree-
 import { TreeViewItemId, TreeViewItemsReorderingAction, TreeViewCancellableEventHandler } from '@mui/x-tree-view/models';
 import { TreeItemDragAndDropOverlayProps } from '@mui/x-tree-view/TreeItemDragAndDropOverlay';
 export interface UseTreeViewItemsReorderingInstance {
-    /**
-     * Check if a given item can be dragged.
-     * @param {TreeViewItemId} itemId The id of the item to check.
-     * @returns {boolean} `true` if the item can be dragged, `false` otherwise.
-     */
-    canItemBeDragged: (itemId: TreeViewItemId) => boolean;
-    /**
-     * Get the valid reordering action if a given item is the target of the ongoing reordering.
-     * @param {TreeViewItemId} itemId The id of the item to get the action of.
-     * @returns {TreeViewItemItemReorderingValidActions} The valid actions for the item.
-     */
-    getDroppingTargetValidActions: (itemId: TreeViewItemId) => TreeViewItemItemReorderingValidActions;
-    /**
-     * Start a reordering for the given item.
-     * @param {TreeViewItemId} itemId The id of the item to start the reordering for.
-     */
-    startDraggingItem: (itemId: TreeViewItemId) => void;
-    /**
-     * Stop the reordering of a given item.
-     * @param {TreeViewItemId} itemId The id of the item to stop the reordering for.
-     */
-    stopDraggingItem: (itemId: TreeViewItemId) => void;
-    /**
-     * Set the new target item for the ongoing reordering.
-     * The action will be determined based on the position of the cursor inside the target and the valid actions for this target.
-     * @param {object} params The params describing the new target item.
-     * @param {TreeViewItemId} params.itemId The id of the new target item.
-     * @param {TreeViewItemItemReorderingValidActions} params.validActions The valid actions for the new target item.
-     * @param {number} params.targetHeight The height of the target item.
-     * @param {number} params.cursorY The Y coordinate of the mouse cursor.
-     * @param {number} params.cursorX The X coordinate of the mouse cursor.
-     * @param {HTMLDivElement} params.contentElement The DOM element rendered for the content slot.
-     */
-    setDragTargetItem: (params: {
-        itemId: TreeViewItemId;
-        validActions: TreeViewItemItemReorderingValidActions;
-        targetHeight: number;
-        cursorY: number;
-        cursorX: number;
-        contentElement: HTMLDivElement;
-    }) => void;
+  /**
+   * Check if a given item can be dragged.
+   * @param {TreeViewItemId} itemId The id of the item to check.
+   * @returns {boolean} `true` if the item can be dragged, `false` otherwise.
+   */
+  canItemBeDragged: (itemId: TreeViewItemId) => boolean;
+  /**
+   * Get the valid reordering action if a given item is the target of the ongoing reordering.
+   * @param {TreeViewItemId} itemId The id of the item to get the action of.
+   * @returns {TreeViewItemItemReorderingValidActions} The valid actions for the item.
+   */
+  getDroppingTargetValidActions: (itemId: TreeViewItemId) => TreeViewItemItemReorderingValidActions;
+  /**
+   * Start a reordering for the given item.
+   * @param {TreeViewItemId} itemId The id of the item to start the reordering for.
+   */
+  startDraggingItem: (itemId: TreeViewItemId) => void;
+  /**
+   * Stop the reordering of a given item.
+   * @param {TreeViewItemId} itemId The id of the item to stop the reordering for.
+   */
+  stopDraggingItem: (itemId: TreeViewItemId) => void;
+  /**
+   * Set the new target item for the ongoing reordering.
+   * The action will be determined based on the position of the cursor inside the target and the valid actions for this target.
+   * @param {object} params The params describing the new target item.
+   * @param {TreeViewItemId} params.itemId The id of the new target item.
+   * @param {TreeViewItemItemReorderingValidActions} params.validActions The valid actions for the new target item.
+   * @param {number} params.targetHeight The height of the target item.
+   * @param {number} params.cursorY The Y coordinate of the mouse cursor.
+   * @param {number} params.cursorX The X coordinate of the mouse cursor.
+   * @param {HTMLDivElement} params.contentElement The DOM element rendered for the content slot.
+   */
+  setDragTargetItem: (params: {
+    itemId: TreeViewItemId;
+    validActions: TreeViewItemItemReorderingValidActions;
+    targetHeight: number;
+    cursorY: number;
+    cursorX: number;
+    contentElement: HTMLDivElement;
+  }) => void;
 }
 export interface TreeViewItemReorderPosition {
-    parentId: string | null;
-    index: number;
+  parentId: string | null;
+  index: number;
 }
-export type TreeViewItemItemReorderingValidActions = {
-    [key in TreeViewItemsReorderingAction]?: TreeViewItemReorderPosition;
-};
+export type TreeViewItemItemReorderingValidActions = { [key in TreeViewItemsReorderingAction]?: TreeViewItemReorderPosition };
 export interface UseTreeViewItemsReorderingParameters {
-    /**
-     * If `true`, the reordering of items is enabled.
-     * Make sure to also enable the `itemsReordering` experimental feature:
-     * `<RichTreeViewPro experimentalFeatures={{ itemsReordering: true }} itemsReordering />`.
-     * @default false
-     */
-    itemsReordering?: boolean;
-    /**
-     * Used to determine if a given item can be reordered.
-     * @param {string} itemId The id of the item to check.
-     * @returns {boolean} `true` if the item can be reordered.
-     * @default () => true
-     */
-    isItemReorderable?: (itemId: string) => boolean;
-    /**
-     * Used to determine if a given item can move to some new position.
-     * @param {object} params The params describing the item re-ordering.
-     * @param {string} params.itemId The id of the item that is being moved to a new position.
-     * @param {TreeViewItemReorderPosition} params.oldPosition The old position of the item.
-     * @param {TreeViewItemReorderPosition} params.newPosition The new position of the item.
-     * @returns {boolean} `true` if the item can move to the new position.
-     */
-    canMoveItemToNewPosition?: (params: {
-        itemId: string;
-        oldPosition: TreeViewItemReorderPosition;
-        newPosition: TreeViewItemReorderPosition;
-    }) => boolean;
-    /**
-     * Callback fired when a Tree Item is moved in the tree.
-     * @param {object} params The params describing the item re-ordering.
-     * @param {string} params.itemId The id of the item moved.
-     * @param {TreeViewItemReorderPosition} params.oldPosition The old position of the item.
-     * @param {TreeViewItemReorderPosition} params.newPosition The new position of the item.
-     */
-    onItemPositionChange?: (params: {
-        itemId: string;
-        oldPosition: TreeViewItemReorderPosition;
-        newPosition: TreeViewItemReorderPosition;
-    }) => void;
+  /**
+   * If `true`, the reordering of items is enabled.
+   * @default false
+   */
+  itemsReordering?: boolean;
+  /**
+   * Determine if a given item can be reordered.
+   * @param {string} itemId The id of the item to check.
+   * @returns {boolean} `true` if the item can be reordered.
+   * @default () => true
+   */
+  isItemReorderable?: (itemId: string) => boolean;
+  /**
+   * Used to determine if a given item can move to some new position.
+   * @param {object} params The params describing the item re-ordering.
+   * @param {string} params.itemId The id of the item that is being moved to a new position.
+   * @param {TreeViewItemReorderPosition} params.oldPosition The old position of the item.
+   * @param {TreeViewItemReorderPosition} params.newPosition The new position of the item.
+   * @returns {boolean} `true` if the item can move to the new position.
+   */
+  canMoveItemToNewPosition?: (params: {
+    itemId: string;
+    oldPosition: TreeViewItemReorderPosition;
+    newPosition: TreeViewItemReorderPosition;
+  }) => boolean;
+  /**
+   * Callback fired when a Tree Item is moved in the tree.
+   * @param {object} params The params describing the item re-ordering.
+   * @param {string} params.itemId The id of the item moved.
+   * @param {TreeViewItemReorderPosition} params.oldPosition The old position of the item.
+   * @param {TreeViewItemReorderPosition} params.newPosition The new position of the item.
+   */
+  onItemPositionChange?: (params: {
+    itemId: string;
+    oldPosition: TreeViewItemReorderPosition;
+    newPosition: TreeViewItemReorderPosition;
+  }) => void;
 }
 export type UseTreeViewItemsReorderingDefaultizedParameters = DefaultizedProps<UseTreeViewItemsReorderingParameters, 'itemsReordering'>;
 export interface UseTreeViewItemsReorderingState {
-    itemsReordering: {
-        draggedItemId: string;
-        targetItemId: string;
-        newPosition: TreeViewItemReorderPosition | null;
-        action: TreeViewItemsReorderingAction | null;
+  itemsReordering: {
+    isItemReorderable: (itemId: string) => boolean;
+    currentReorder: {
+      draggedItemId: string;
+      targetItemId: string;
+      newPosition: TreeViewItemReorderPosition | null;
+      action: TreeViewItemsReorderingAction | null;
     } | null;
-}
-interface UseTreeViewItemsReorderingContextValue {
-    itemsReordering: {
-        enabled: boolean;
-        isItemReorderable: ((itemId: string) => boolean) | undefined;
-    };
+  };
 }
 export type UseTreeViewItemsReorderingSignature = TreeViewPluginSignature<{
-    params: UseTreeViewItemsReorderingParameters;
-    defaultizedParams: UseTreeViewItemsReorderingDefaultizedParameters;
-    instance: UseTreeViewItemsReorderingInstance;
-    state: UseTreeViewItemsReorderingState;
-    contextValue: UseTreeViewItemsReorderingContextValue;
-    experimentalFeatures: 'itemsReordering';
-    dependencies: [UseTreeViewItemsSignature];
+  params: UseTreeViewItemsReorderingParameters;
+  defaultizedParams: UseTreeViewItemsReorderingDefaultizedParameters;
+  instance: UseTreeViewItemsReorderingInstance;
+  state: UseTreeViewItemsReorderingState;
+  dependencies: [UseTreeViewItemsSignature];
 }>;
 export interface UseTreeItemRootSlotPropsFromItemsReordering {
-    draggable?: true;
-    onDragStart?: TreeViewCancellableEventHandler<React.DragEvent>;
-    onDragOver?: TreeViewCancellableEventHandler<React.DragEvent>;
-    onDragEnd?: TreeViewCancellableEventHandler<React.DragEvent>;
+  draggable?: true;
+  onDragStart?: TreeViewCancellableEventHandler<React.DragEvent>;
+  onDragOver?: TreeViewCancellableEventHandler<React.DragEvent>;
+  onDragEnd?: TreeViewCancellableEventHandler<React.DragEvent>;
 }
 export interface UseTreeItemContentSlotPropsFromItemsReordering {
-    onDragEnter?: TreeViewCancellableEventHandler<React.DragEvent>;
-    onDragOver?: TreeViewCancellableEventHandler<React.DragEvent>;
-}
-export interface UseTreeItemDragAndDropOverlaySlotPropsFromItemsReordering extends TreeItemDragAndDropOverlayProps {
+  onDragEnter?: TreeViewCancellableEventHandler<React.DragEvent>;
+  onDragOver?: TreeViewCancellableEventHandler<React.DragEvent>;
 }
+export interface UseTreeItemDragAndDropOverlaySlotPropsFromItemsReordering extends TreeItemDragAndDropOverlayProps {}
 declare module '@mui/x-tree-view/useTreeItem' {
-    interface UseTreeItemRootSlotOwnProps extends UseTreeItemRootSlotPropsFromItemsReordering {
-    }
-    interface UseTreeItemContentSlotOwnProps extends UseTreeItemContentSlotPropsFromItemsReordering {
-    }
-    interface UseTreeItemDragAndDropOverlaySlotOwnProps extends UseTreeItemDragAndDropOverlaySlotPropsFromItemsReordering {
-    }
-}
-export {};
+  interface UseTreeItemRootSlotOwnProps extends UseTreeItemRootSlotPropsFromItemsReordering {}
+  interface UseTreeItemContentSlotOwnProps extends UseTreeItemContentSlotPropsFromItemsReordering {}
+  interface UseTreeItemDragAndDropOverlaySlotOwnProps extends UseTreeItemDragAndDropOverlaySlotPropsFromItemsReordering {}
+}

package/internals/plugins/useTreeViewItemsReordering/useTreeViewItemsReordering.types.js

@@ -1 +1,5 @@
-export {};
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/internals/plugins/useTreeViewItemsReordering/useTreeViewItemsReordering.utils.d.ts

@@ -1,24 +1,37 @@
 import { TreeViewUsedStore, UseTreeViewItemsState } from '@mui/x-tree-view/internals';
 import { TreeViewItemId, TreeViewItemsReorderingAction } from '@mui/x-tree-view/models';
-import { TreeViewItemItemReorderingValidActions, TreeViewItemReorderPosition, UseTreeViewItemsReorderingSignature } from './useTreeViewItemsReordering.types';
+import { TreeViewItemItemReorderingValidActions, TreeViewItemReorderPosition, UseTreeViewItemsReorderingSignature } from "./useTreeViewItemsReordering.types.js";
 /**
  * Checks if the item with the id itemIdB is an ancestor of the item with the id itemIdA.
  */
 export declare const isAncestor: (store: TreeViewUsedStore<UseTreeViewItemsReorderingSignature>, itemIdA: string, itemIdB: string) => boolean;
 interface GetNewPositionParams {
-    itemChildrenIndentation: string | number;
-    validActions: TreeViewItemItemReorderingValidActions;
-    targetHeight: number;
-    targetDepth: number;
-    cursorY: number;
-    cursorX: number;
-    contentElement: HTMLDivElement;
+  itemChildrenIndentation: string | number;
+  validActions: TreeViewItemItemReorderingValidActions;
+  targetHeight: number;
+  targetDepth: number;
+  cursorY: number;
+  cursorX: number;
+  contentElement: HTMLDivElement;
 }
-export declare const chooseActionToApply: ({ itemChildrenIndentation, validActions, targetHeight, targetDepth, cursorX, cursorY, contentElement, }: GetNewPositionParams) => TreeViewItemsReorderingAction | null;
-export declare const moveItemInTree: <R extends {}>({ itemToMoveId, oldPosition, newPosition, prevState, }: {
-    itemToMoveId: TreeViewItemId;
-    oldPosition: TreeViewItemReorderPosition;
-    newPosition: TreeViewItemReorderPosition;
-    prevState: UseTreeViewItemsState<R>["items"];
+export declare const chooseActionToApply: ({
+  itemChildrenIndentation,
+  validActions,
+  targetHeight,
+  targetDepth,
+  cursorX,
+  cursorY,
+  contentElement
+}: GetNewPositionParams) => TreeViewItemsReorderingAction | null;
+export declare const moveItemInTree: <R extends {}>({
+  itemToMoveId,
+  oldPosition,
+  newPosition,
+  prevState
+}: {
+  itemToMoveId: TreeViewItemId;
+  oldPosition: TreeViewItemReorderPosition;
+  newPosition: TreeViewItemReorderPosition;
+  prevState: UseTreeViewItemsState<R>["items"];
 }) => UseTreeViewItemsState<R>["items"];
-export {};
+export {};

package/internals/plugins/useTreeViewItemsReordering/useTreeViewItemsReordering.utils.js

@@ -1,10 +1,17 @@
-import _extends from "@babel/runtime/helpers/esm/extends";
-import { buildSiblingIndexes, TREE_VIEW_ROOT_PARENT_ID, selectorItemMeta } from '@mui/x-tree-view/internals';
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.moveItemInTree = exports.isAncestor = exports.chooseActionToApply = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _internals = require("@mui/x-tree-view/internals");
 /**
  * Checks if the item with the id itemIdB is an ancestor of the item with the id itemIdA.
  */
-export const isAncestor = (store, itemIdA, itemIdB) => {
-  const itemMetaA = selectorItemMeta(store.value, itemIdA);
+const isAncestor = (store, itemIdA, itemIdB) => {
+  const itemMetaA = (0, _internals.selectorItemMeta)(store.value, itemIdA);
   if (itemMetaA.parentId === itemIdB) {
     return true;
   }
@@ -19,6 +26,7 @@ export const isAncestor = (store, itemIdA, itemIdB) => {
  * @param {string | null} itemChildrenIndentation The indentation as passed to the `itemChildrenIndentation` prop.
  * @param {HTMLElement} contentElement The DOM element to which the indentation will be applied.
  */
+exports.isAncestor = isAncestor;
 const parseItemChildrenIndentation = (itemChildrenIndentation, contentElement) => {
   if (typeof itemChildrenIndentation === 'number') {
     return itemChildrenIndentation;
@@ -37,7 +45,7 @@ const parseItemChildrenIndentation = (itemChildrenIndentation, contentElement) =
   contentElement.removeChild(tempElement);
   return value;
 };
-export const chooseActionToApply = ({
+const chooseActionToApply = ({
   itemChildrenIndentation,
   validActions,
   targetHeight,
@@ -82,23 +90,24 @@ export const chooseActionToApply = ({
   }
   return action;
 };
-export const moveItemInTree = ({
+exports.chooseActionToApply = chooseActionToApply;
+const moveItemInTree = ({
   itemToMoveId,
   oldPosition,
   newPosition,
   prevState
 }) => {
   const itemToMoveMeta = prevState.itemMetaLookup[itemToMoveId];
-  const oldParentId = oldPosition.parentId ?? TREE_VIEW_ROOT_PARENT_ID;
-  const newParentId = newPosition.parentId ?? TREE_VIEW_ROOT_PARENT_ID;
+  const oldParentId = oldPosition.parentId ?? _internals.TREE_VIEW_ROOT_PARENT_ID;
+  const newParentId = newPosition.parentId ?? _internals.TREE_VIEW_ROOT_PARENT_ID;
 
   // 1. Update the `itemOrderedChildrenIds`.
-  const itemOrderedChildrenIds = _extends({}, prevState.itemOrderedChildrenIdsLookup);
+  const itemOrderedChildrenIds = (0, _extends2.default)({}, prevState.itemOrderedChildrenIdsLookup);
   if (oldParentId === newParentId) {
     const updatedChildren = [...itemOrderedChildrenIds[oldParentId]];
     updatedChildren.splice(oldPosition.index, 1);
     updatedChildren.splice(newPosition.index, 0, itemToMoveId);
-    itemOrderedChildrenIds[itemToMoveMeta.parentId ?? TREE_VIEW_ROOT_PARENT_ID] = updatedChildren;
+    itemOrderedChildrenIds[itemToMoveMeta.parentId ?? _internals.TREE_VIEW_ROOT_PARENT_ID] = updatedChildren;
   } else {
     const updatedOldParentChildren = [...itemOrderedChildrenIds[oldParentId]];
     updatedOldParentChildren.splice(oldPosition.index, 1);
@@ -109,50 +118,51 @@ export const moveItemInTree = ({
   }
 
   // 2. Update the `itemChildrenIndexes`
-  const itemChildrenIndexes = _extends({}, prevState.itemChildrenIndexesLookup);
-  itemChildrenIndexes[oldParentId] = buildSiblingIndexes(itemOrderedChildrenIds[oldParentId]);
+  const itemChildrenIndexes = (0, _extends2.default)({}, prevState.itemChildrenIndexesLookup);
+  itemChildrenIndexes[oldParentId] = (0, _internals.buildSiblingIndexes)(itemOrderedChildrenIds[oldParentId]);
   if (newParentId !== oldParentId) {
-    itemChildrenIndexes[newParentId] = buildSiblingIndexes(itemOrderedChildrenIds[newParentId]);
+    itemChildrenIndexes[newParentId] = (0, _internals.buildSiblingIndexes)(itemOrderedChildrenIds[newParentId]);
   }
 
   // 3. Update the `itemMetaLookup`
-  const itemMetaLookup = _extends({}, prevState.itemMetaLookup);
+  const itemMetaLookup = (0, _extends2.default)({}, prevState.itemMetaLookup);
 
   // 3.1 Update the `expandable` property of the old and the new parent
   function updateExpandable(itemId) {
     const isExpandable = itemOrderedChildrenIds[itemId].length > 0;
     if (itemMetaLookup[itemId].expandable !== isExpandable) {
-      itemMetaLookup[itemId] = _extends({}, itemMetaLookup[itemId], {
+      itemMetaLookup[itemId] = (0, _extends2.default)({}, itemMetaLookup[itemId], {
         expandable: isExpandable
       });
     }
   }
-  if (oldParentId !== TREE_VIEW_ROOT_PARENT_ID && oldParentId !== newParentId) {
+  if (oldParentId !== _internals.TREE_VIEW_ROOT_PARENT_ID && oldParentId !== newParentId) {
     updateExpandable(oldParentId);
   }
-  if (newParentId !== TREE_VIEW_ROOT_PARENT_ID && newParentId !== oldParentId) {
+  if (newParentId !== _internals.TREE_VIEW_ROOT_PARENT_ID && newParentId !== oldParentId) {
     updateExpandable(newParentId);
   }
 
   // 3.2 Update the `parentId` and `depth` properties of the item to move
   // The depth is always defined because drag&drop is only usable with Rich Tree View components.
   const itemToMoveDepth = newPosition.parentId == null ? 0 : itemMetaLookup[newParentId].depth + 1;
-  itemMetaLookup[itemToMoveId] = _extends({}, itemToMoveMeta, {
+  itemMetaLookup[itemToMoveId] = (0, _extends2.default)({}, itemToMoveMeta, {
     parentId: newPosition.parentId,
     depth: itemToMoveDepth
   });
 
   // 3.3 Update the depth of all the children of the item to move
   const updateItemDepth = (itemId, depth) => {
-    itemMetaLookup[itemId] = _extends({}, itemMetaLookup[itemId], {
+    itemMetaLookup[itemId] = (0, _extends2.default)({}, itemMetaLookup[itemId], {
       depth
     });
     itemOrderedChildrenIds[itemId]?.forEach(childId => updateItemDepth(childId, depth + 1));
   };
   itemOrderedChildrenIds[itemToMoveId]?.forEach(childId => updateItemDepth(childId, itemToMoveDepth + 1));
-  return _extends({}, prevState, {
+  return (0, _extends2.default)({}, prevState, {
     itemOrderedChildrenIdsLookup: itemOrderedChildrenIds,
     itemChildrenIndexesLookup: itemChildrenIndexes,
     itemMetaLookup
   });
-};
+};
+exports.moveItemInTree = moveItemInTree;

package/internals/plugins/useTreeViewLazyLoading/index.d.ts

@@ -0,0 +1 @@
+export { useTreeViewLazyLoading } from "./useTreeViewLazyLoading.js";

package/internals/plugins/useTreeViewLazyLoading/index.js

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

package/internals/plugins/useTreeViewLazyLoading/useTreeViewLazyLoading.d.ts

@@ -0,0 +1,3 @@
+import { TreeViewPlugin } from '@mui/x-tree-view/internals';
+import type { UseTreeViewLazyLoadingSignature } from '@mui/x-tree-view/internals';
+export declare const useTreeViewLazyLoading: TreeViewPlugin<UseTreeViewLazyLoadingSignature>;