@headless-tree/core 1.6.1 → 1.6.3

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @headless-tree/core
 
+## 1.6.3
+
+### Patch Changes
+
+- 4397d8c: Added `draggedItemOverwritesSelection` as config option to the Drag Feature. Setting it to false will disable the current default behavior, where dragging an unselected item will overwrite the selection to just the dragged item.
+
+## 1.6.2
+
+### Patch Changes
+
+- 39a8b44: Add skipUpdateTree parameter to `updateCachedChildrenIds` and `updateCachedData` in async tree loader
+- 26ecc1b: Fixed an issue where dropping items inside a collapsed folder will make the tree become un-focusable until a new item is clicked with mouse again. This could break usage with keyboard-only drag operations.
+- 0108b7a: Fixed a bug where some hotkeys (like up/down navigation, search and renaming) doesn't work after items are dragged within the tree (#179)
+- ffd2619: Fixed an issue where `canDropForeignDragObject` was being called in `onDragOver` events without payload. `canDropForeignDragObject` should never be called in `onDragOver` events since there, browsers do not allow access to the data transfer payload. Now, `canDropForeignDragObject` is only called in onDrop events, and `canDragForeignDragObjectOver` is always called in `onDragOver` events.
+
 ## 1.6.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -68,6 +68,11 @@ type DragAndDropFeatureDef<T> = {
         onCompleteForeignDrop?: (items: ItemInstance<T>[]) => void;
         /** When dragging for this many ms on a closed folder, the folder will automatically open. Set to zero to disable. */
         openOnDropDelay?: number;
+        /** If true, `item.getProps()` will not include drag event handlers. Use `item.getDragHandleProps()` on the handler element. */
+        seperateDragHandle?: boolean;
+        /** If true, the item that is dragged is not selected, the selected items will be overwritten to just the dragged item.
+         * Defaults to true */
+        draggedItemOverwritesSelection?: boolean;
     };
     treeInstance: {
         getDragTarget: () => DragTarget<T> | null;
@@ -84,6 +89,9 @@ type DragAndDropFeatureDef<T> = {
         isDragTargetAbove: () => boolean;
         isDragTargetBelow: () => boolean;
         isDraggingOver: () => boolean;
+        /** Note that `item.getProps()` already passes in all drag event handlers by default. Set `seperateDragHandle` to true to
+         * disable the default behavior and use this on the handler element instead. */
+        getDragHandleProps: () => Record<string, any>;
     };
     hotkeys: never;
 };
@@ -329,9 +337,11 @@ type AsyncDataLoaderFeatureDef<T> = {
          * @param optimistic If true, the item will not trigger a state update on `loadingItemChildrens`, and
          * the tree will continue to display the old data until the new data has loaded. */
         invalidateChildrenIds: (optimistic?: boolean) => Promise<void>;
-        /** Set to undefined to clear cache without triggering automatic refetch. Use @invalidateItemData to clear and triggering refetch. */
-        updateCachedData: (data: T | undefined) => void;
-        updateCachedChildrenIds: (childrenIds: string[]) => void;
+        /** Set to undefined to clear cache without triggering automatic refetch. Use @invalidateItemData to clear and triggering refetch.
+         * @param skipUpdateTree If true, the tree will not rebuild the tree structure cache afterwards by calling `tree.rebuildTree()`. */
+        updateCachedData: (data: T | undefined, skipUpdateTree?: boolean) => void;
+        /** @param skipUpdateTree If true, the tree will not rebuild the tree structure cache afterwards by calling `tree.rebuildTree()`. */
+        updateCachedChildrenIds: (childrenIds: string[], skipUpdateTree?: boolean) => void;
         hasLoadedData: () => boolean;
         isLoading: () => boolean;
     };
@@ -420,6 +430,7 @@ interface PropMemoizationDataRef {
     memo?: {
         tree?: Record<string, any>;
         item?: Record<string, any>;
+        drag?: Record<string, any>;
         search?: Record<string, any>;
         rename?: Record<string, any>;
     };

package/dist/index.d.ts

@@ -68,6 +68,11 @@ type DragAndDropFeatureDef<T> = {
         onCompleteForeignDrop?: (items: ItemInstance<T>[]) => void;
         /** When dragging for this many ms on a closed folder, the folder will automatically open. Set to zero to disable. */
         openOnDropDelay?: number;
+        /** If true, `item.getProps()` will not include drag event handlers. Use `item.getDragHandleProps()` on the handler element. */
+        seperateDragHandle?: boolean;
+        /** If true, the item that is dragged is not selected, the selected items will be overwritten to just the dragged item.
+         * Defaults to true */
+        draggedItemOverwritesSelection?: boolean;
     };
     treeInstance: {
         getDragTarget: () => DragTarget<T> | null;
@@ -84,6 +89,9 @@ type DragAndDropFeatureDef<T> = {
         isDragTargetAbove: () => boolean;
         isDragTargetBelow: () => boolean;
         isDraggingOver: () => boolean;
+        /** Note that `item.getProps()` already passes in all drag event handlers by default. Set `seperateDragHandle` to true to
+         * disable the default behavior and use this on the handler element instead. */
+        getDragHandleProps: () => Record<string, any>;
     };
     hotkeys: never;
 };
@@ -329,9 +337,11 @@ type AsyncDataLoaderFeatureDef<T> = {
          * @param optimistic If true, the item will not trigger a state update on `loadingItemChildrens`, and
          * the tree will continue to display the old data until the new data has loaded. */
         invalidateChildrenIds: (optimistic?: boolean) => Promise<void>;
-        /** Set to undefined to clear cache without triggering automatic refetch. Use @invalidateItemData to clear and triggering refetch. */
-        updateCachedData: (data: T | undefined) => void;
-        updateCachedChildrenIds: (childrenIds: string[]) => void;
+        /** Set to undefined to clear cache without triggering automatic refetch. Use @invalidateItemData to clear and triggering refetch.
+         * @param skipUpdateTree If true, the tree will not rebuild the tree structure cache afterwards by calling `tree.rebuildTree()`. */
+        updateCachedData: (data: T | undefined, skipUpdateTree?: boolean) => void;
+        /** @param skipUpdateTree If true, the tree will not rebuild the tree structure cache afterwards by calling `tree.rebuildTree()`. */
+        updateCachedChildrenIds: (childrenIds: string[], skipUpdateTree?: boolean) => void;
         hasLoadedData: () => boolean;
         isLoading: () => boolean;
     };
@@ -420,6 +430,7 @@ interface PropMemoizationDataRef {
     memo?: {
         tree?: Record<string, any>;
         item?: Record<string, any>;
+        drag?: Record<string, any>;
         search?: Record<string, any>;
         rename?: Record<string, any>;
     };

package/dist/index.js

@@ -125,6 +125,7 @@ var poll = (fn, interval = 100, timeout = 1e3) => new Promise((resolve) => {
   }, interval);
   clear = setTimeout(() => {
     clearInterval(i);
+    resolve();
   }, timeout);
 });
 
@@ -214,12 +215,16 @@ var treeFeature = {
     },
     updateDomFocus: ({ tree }) => {
       setTimeout(() => __async(null, null, function* () {
-        var _a, _b;
+        var _a, _b, _c, _d, _e;
         const focusedItem = tree.getFocusedItem();
         (_b = (_a = tree.getConfig()).scrollToItem) == null ? void 0 : _b.call(_a, focusedItem);
-        yield poll(() => focusedItem.getElement() !== null, 20);
+        yield poll(() => focusedItem.getElement() !== null, 20, 500);
         const focusedElement = focusedItem.getElement();
-        if (!focusedElement) return;
+        if (!focusedElement) {
+          (_c = tree.getItems()[0]) == null ? void 0 : _c.setFocused();
+          (_e = (_d = tree.getItems()[0]) == null ? void 0 : _d.getElement()) == null ? void 0 : _e.focus();
+          return;
+        }
         focusedElement.focus();
       }));
     },
@@ -1020,6 +1025,7 @@ var checkboxesFeature = {
 };
 
 // src/features/hotkeys-core/feature.ts
+var resolveKeyCode = (e) => e.code !== "" && e.code !== "Unidentified" ? e.code : e.key;
 var specialKeys = {
   // TODO:breaking deprecate auto-lowercase
   letter: /^Key[A-Z]$/,
@@ -1068,9 +1074,10 @@ var hotkeysCoreFeature = {
       if (e.target instanceof HTMLInputElement && ignoreHotkeysOnInputs) {
         return;
       }
+      const resolvedCode = resolveKeyCode(e);
       (_b = (_a = data.current).pressedKeys) != null ? _b : _a.pressedKeys = /* @__PURE__ */ new Set();
-      const newMatch = !data.current.pressedKeys.has(e.code);
-      data.current.pressedKeys.add(e.code);
+      const newMatch = !data.current.pressedKeys.has(resolvedCode);
+      data.current.pressedKeys.add(resolvedCode);
       const hotkeyName = findHotkeyMatch(
         data.current.pressedKeys,
         tree,
@@ -1078,7 +1085,7 @@ var hotkeysCoreFeature = {
         hotkeys
       );
       if (e.target instanceof HTMLInputElement) {
-        data.current.pressedKeys.delete(e.code);
+        data.current.pressedKeys.delete(resolvedCode);
       }
       if (!hotkeyName) return;
       const hotkeyConfig = __spreadValues(__spreadValues({}, tree.getHotkeyPresets()[hotkeyName]), hotkeys == null ? void 0 : hotkeys[hotkeyName]);
@@ -1093,7 +1100,7 @@ var hotkeysCoreFeature = {
     const keyup = (e) => {
       var _a, _b;
       (_b = (_a = data.current).pressedKeys) != null ? _b : _a.pressedKeys = /* @__PURE__ */ new Set();
-      data.current.pressedKeys.delete(e.code);
+      data.current.pressedKeys.delete(resolveKeyCode(e));
     };
     const reset = () => {
       data.current.pressedKeys = /* @__PURE__ */ new Set();
@@ -1274,15 +1281,17 @@ var asyncDataLoaderFeature = {
       }
       yield loadChildrenIds(tree, itemId);
     }),
-    updateCachedChildrenIds: ({ tree, itemId }, childrenIds) => {
-      const dataRef = tree.getDataRef();
-      dataRef.current.childrenIds[itemId] = childrenIds;
-      tree.rebuildTree();
+    updateCachedChildrenIds: ({ tree, itemId }, childrenIds, skipUpdateTree) => {
+      getDataRef(tree).current.childrenIds[itemId] = childrenIds;
+      if (!skipUpdateTree) {
+        tree.rebuildTree();
+      }
     },
-    updateCachedData: ({ tree, itemId }, data) => {
-      const dataRef = tree.getDataRef();
-      dataRef.current.itemData[itemId] = data;
-      tree.rebuildTree();
+    updateCachedData: ({ tree, itemId }, data, skipUpdateTree) => {
+      getDataRef(tree).current.itemData[itemId] = data;
+      if (!skipUpdateTree) {
+        tree.rebuildTree();
+      }
     },
     hasLoadedData: ({ tree, itemId }) => {
       const dataRef = tree.getDataRef();
@@ -1449,15 +1458,16 @@ var getReparentTarget = (item, reparentLevel, draggedItems) => {
     dragLineLevel: reparentLevel
   };
 };
-var getDragTarget = (e, item, tree, canReorder = tree.getConfig().canReorder) => {
+var getDragTarget = (e, item, tree, hasDataTransferPayload, canReorder = tree.getConfig().canReorder) => {
   var _a;
+  const dataTransfer = hasDataTransferPayload ? e.dataTransfer : null;
   const draggedItems = (_a = tree.getState().dnd) == null ? void 0 : _a.draggedItems;
   const itemMeta = item.getItemMeta();
   const parent = item.getParent();
   const itemTarget = { item };
   const parentTarget = parent ? { item: parent } : null;
-  const canBecomeSibling = parentTarget && canDrop(e.dataTransfer, parentTarget, tree);
-  const canMakeChild = canDrop(e.dataTransfer, itemTarget, tree);
+  const canBecomeSibling = parentTarget && canDrop(dataTransfer, parentTarget, tree);
+  const canMakeChild = canDrop(dataTransfer, itemTarget, tree);
   const placement = getTargetPlacement(e, item, tree, canMakeChild);
   if (!canReorder && parent && canBecomeSibling && placement.type !== 2 /* MakeChild */) {
     if (draggedItems == null ? void 0 : draggedItems.some((item2) => item2.isDescendentOf(parent.getId()))) {
@@ -1466,7 +1476,7 @@ var getDragTarget = (e, item, tree, canReorder = tree.getConfig().canReorder) =>
     return parentTarget;
   }
   if (!canReorder && parent && !canBecomeSibling) {
-    return getDragTarget(e, parent, tree, false);
+    return getDragTarget(e, parent, tree, hasDataTransferPayload, false);
   }
   if (!parent) {
     return itemTarget;
@@ -1475,7 +1485,7 @@ var getDragTarget = (e, item, tree, canReorder = tree.getConfig().canReorder) =>
     return itemTarget;
   }
   if (!canBecomeSibling) {
-    return getDragTarget(e, parent, tree, false);
+    return getDragTarget(e, parent, tree, hasDataTransferPayload, false);
   }
   if (placement.type === 3 /* Reparent */) {
     return getReparentTarget(item, placement.reparentLevel, draggedItems);
@@ -1519,7 +1529,8 @@ var dragAndDropFeature = {
     canDragForeignDragObjectOver: defaultConfig.canDropForeignDragObject !== defaultCanDropForeignDragObject ? (dataTransfer) => dataTransfer.effectAllowed !== "none" : () => false,
     setDndState: makeStateUpdater("dnd", tree),
     canReorder: true,
-    openOnDropDelay: 800
+    openOnDropDelay: 800,
+    draggedItemOverwritesSelection: true
   }, defaultConfig),
   stateHandlerNames: {
     dnd: "setDndState"
@@ -1612,36 +1623,8 @@ var dragAndDropFeature = {
     }
   },
   itemInstance: {
-    getProps: ({ tree, item, prev }) => __spreadProps(__spreadValues({}, prev == null ? void 0 : prev()), {
-      draggable: true,
+    getProps: ({ tree, item, prev }) => __spreadProps(__spreadValues(__spreadValues({}, prev == null ? void 0 : prev()), tree.getConfig().seperateDragHandle ? {} : item.getDragHandleProps()), {
       onDragEnter: (e) => e.preventDefault(),
-      onDragStart: (e) => {
-        var _a, _b, _c, _d;
-        const selectedItems = tree.getSelectedItems ? tree.getSelectedItems() : [tree.getFocusedItem()];
-        const items = selectedItems.includes(item) ? selectedItems : [item];
-        const config = tree.getConfig();
-        if (!selectedItems.includes(item)) {
-          (_a = tree.setSelectedItems) == null ? void 0 : _a.call(tree, [item.getItemMeta().itemId]);
-        }
-        if (!((_c = (_b = config.canDrag) == null ? void 0 : _b.call(config, items)) != null ? _c : true)) {
-          e.preventDefault();
-          return;
-        }
-        if (config.setDragImage) {
-          const { imgElement, xOffset, yOffset } = config.setDragImage(items);
-          (_d = e.dataTransfer) == null ? void 0 : _d.setDragImage(imgElement, xOffset != null ? xOffset : 0, yOffset != null ? yOffset : 0);
-        }
-        if (config.createForeignDragObject && e.dataTransfer) {
-          const { format, data, dropEffect, effectAllowed } = config.createForeignDragObject(items);
-          e.dataTransfer.setData(format, data);
-          if (dropEffect) e.dataTransfer.dropEffect = dropEffect;
-          if (effectAllowed) e.dataTransfer.effectAllowed = effectAllowed;
-        }
-        tree.applySubStateUpdate("dnd", {
-          draggedItems: items,
-          draggingOverItem: tree.getFocusedItem()
-        });
-      },
       onDragOver: (e) => {
         var _a, _b, _c;
         e.stopPropagation();
@@ -1657,12 +1640,12 @@ var dragAndDropFeature = {
         dataRef.current.lastDragCode = nextDragCode;
         dataRef.current.lastDragEnter = Date.now();
         handleAutoOpenFolder(dataRef, tree, item, placement);
-        const target = getDragTarget(e, item, tree);
+        const target = getDragTarget(e, item, tree, false);
         if (!((_a = tree.getState().dnd) == null ? void 0 : _a.draggedItems) && (!e.dataTransfer || !((_c = (_b = tree.getConfig()).canDragForeignDragObjectOver) == null ? void 0 : _c.call(_b, e.dataTransfer, target)))) {
           dataRef.current.lastAllowDrop = false;
           return;
         }
-        if (!canDrop(e.dataTransfer, target, tree)) {
+        if (!canDrop(null, target, tree)) {
           dataRef.current.lastAllowDrop = false;
           return;
         }
@@ -1685,24 +1668,11 @@ var dragAndDropFeature = {
           }));
         }, 100);
       },
-      onDragEnd: (e) => {
-        var _a, _b;
-        const { onCompleteForeignDrop, canDragForeignDragObjectOver } = tree.getConfig();
-        const draggedItems = (_a = tree.getState().dnd) == null ? void 0 : _a.draggedItems;
-        if (((_b = e.dataTransfer) == null ? void 0 : _b.dropEffect) === "none" || !draggedItems) {
-          return;
-        }
-        const target = getDragTarget(e, item, tree);
-        if (canDragForeignDragObjectOver && e.dataTransfer && !canDragForeignDragObjectOver(e.dataTransfer, target)) {
-          return;
-        }
-        onCompleteForeignDrop == null ? void 0 : onCompleteForeignDrop(draggedItems);
-      },
       onDrop: (e) => __async(null, null, function* () {
         var _a, _b, _c;
         e.stopPropagation();
         const dataRef = tree.getDataRef();
-        const target = getDragTarget(e, item, tree);
+        const target = getDragTarget(e, item, tree, true);
         const draggedItems = (_a = tree.getState().dnd) == null ? void 0 : _a.draggedItems;
         const isValidDrop = canDrop(e.dataTransfer, target, tree);
         tree.applySubStateUpdate("dnd", {
@@ -1718,11 +1688,59 @@ var dragAndDropFeature = {
         dataRef.current.lastDragCode = void 0;
         if (draggedItems) {
           yield (_b = config.onDrop) == null ? void 0 : _b.call(config, draggedItems, target);
+          draggedItems[0].setFocused();
         } else if (e.dataTransfer) {
           yield (_c = config.onDropForeignDragObject) == null ? void 0 : _c.call(config, e.dataTransfer, target);
         }
+        tree.applySubStateUpdate("dnd", null);
+        tree.updateDomFocus();
       })
     }),
+    getDragHandleProps: ({ tree, item, prev }) => __spreadProps(__spreadValues({}, prev == null ? void 0 : prev()), {
+      draggable: true,
+      onDragStart: (e) => {
+        var _a, _b, _c, _d;
+        const { draggedItemOverwritesSelection } = tree.getConfig();
+        const selectedItems = tree.getSelectedItems ? tree.getSelectedItems() : [tree.getFocusedItem()];
+        const overwriteSelection = !selectedItems.includes(item) && draggedItemOverwritesSelection;
+        const items = overwriteSelection ? [item] : selectedItems;
+        const config = tree.getConfig();
+        if (overwriteSelection) {
+          (_a = tree.setSelectedItems) == null ? void 0 : _a.call(tree, [item.getItemMeta().itemId]);
+        }
+        if (!((_c = (_b = config.canDrag) == null ? void 0 : _b.call(config, items)) != null ? _c : true)) {
+          e.preventDefault();
+          return;
+        }
+        if (config.setDragImage) {
+          const { imgElement, xOffset, yOffset } = config.setDragImage(items);
+          (_d = e.dataTransfer) == null ? void 0 : _d.setDragImage(imgElement, xOffset != null ? xOffset : 0, yOffset != null ? yOffset : 0);
+        }
+        if (config.createForeignDragObject && e.dataTransfer) {
+          const { format, data, dropEffect, effectAllowed } = config.createForeignDragObject(items);
+          e.dataTransfer.setData(format, data);
+          if (dropEffect) e.dataTransfer.dropEffect = dropEffect;
+          if (effectAllowed) e.dataTransfer.effectAllowed = effectAllowed;
+        }
+        tree.applySubStateUpdate("dnd", {
+          draggedItems: items,
+          draggingOverItem: tree.getFocusedItem()
+        });
+      },
+      onDragEnd: (e) => {
+        var _a, _b;
+        const { onCompleteForeignDrop, canDragForeignDragObjectOver } = tree.getConfig();
+        const draggedItems = (_a = tree.getState().dnd) == null ? void 0 : _a.draggedItems;
+        if (((_b = e.dataTransfer) == null ? void 0 : _b.dropEffect) === "none" || !draggedItems) {
+          return;
+        }
+        const target = getDragTarget(e, item, tree, false);
+        if (canDragForeignDragObjectOver && e.dataTransfer && !canDragForeignDragObjectOver(e.dataTransfer, target)) {
+          return;
+        }
+        onCompleteForeignDrop == null ? void 0 : onCompleteForeignDrop(draggedItems);
+      }
+    }),
     isDragTarget: ({ tree, item }) => {
       const target = tree.getDragTarget();
       return target ? target.item.getId() === item.getId() : false;
@@ -1946,6 +1964,7 @@ var keyboardDragAndDropFeature = {
         } else if (dataTransfer) {
           yield (_d = config.onDropForeignDragObject) == null ? void 0 : _d.call(config, dataTransfer, target);
         }
+        tree.updateDomFocus();
         tree.applySubStateUpdate(
           "assistiveDndState",
           3 /* Completed */
@@ -2296,6 +2315,14 @@ var propMemoizationFeature = {
       (_e = (_d = dataRef.current.memo).item) != null ? _e : _d.item = {};
       return memoize(props, dataRef.current.memo.item);
     },
+    getDragHandleProps: ({ item, prev }) => {
+      var _a, _b, _c, _d, _e;
+      const dataRef = item.getDataRef();
+      const props = (_a = prev == null ? void 0 : prev()) != null ? _a : {};
+      (_c = (_b = dataRef.current).memo) != null ? _c : _b.memo = {};
+      (_e = (_d = dataRef.current.memo).drag) != null ? _e : _d.drag = {};
+      return memoize(props, dataRef.current.memo.drag);
+    },
     getRenameInputProps: ({ item, prev }) => {
       var _a, _b, _c, _d, _e;
       const dataRef = item.getDataRef();