react-arborist 3.10.1 → 3.10.3

package/README.md

@@ -800,6 +800,22 @@ function Node({ node, style }) {
 
 Pass a partial `chars` object to override any of the default characters (e.g. for an ASCII-only style).
 
+## Contributing
+
+The package ships with Jest tests under `modules/react-arborist/src/**/*.test.ts?(x)`.
+From the package directory you can run:
+
+```bash
+cd modules/react-arborist
+yarn test
+```
+
+Good starting points:
+
+- `src/interfaces/tree-api.test.ts` for pure API behavior
+- `src/components/provider.test.tsx` for rendered tree behavior
+- `src/dnd/drag-hook.test.ts` for drag-and-drop behavior
+
 ## Author
 
 [James Kerr](https://twitter.com/specialCaseDev) at [Brim Data](https://brimdata.io) for the [Zui desktop app](https://www.youtube.com/watch?v=I2y663n8d2A).

package/dist/main/dnd/drag-hook.d.ts

@@ -2,4 +2,5 @@ import { ConnectDragSource } from "react-dnd";
 import { NodeApi } from "../interfaces/node-api";
 import { TreeProps } from "../types/tree-props";
 export declare function dragTypeForNode<T>(dragType: TreeProps<T>["dragType"], node: NodeApi<T>): string;
+export declare function canDragNode<T>(node: NodeApi<T>): boolean;
 export declare function useDragHook<T>(node: NodeApi<T>): ConnectDragSource;

package/dist/main/dnd/drag-hook.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.dragTypeForNode = dragTypeForNode;
+exports.canDragNode = canDragNode;
 exports.useDragHook = useDragHook;
 const react_1 = require("react");
 const react_dnd_1 = require("react-dnd");
@@ -14,11 +15,17 @@ function dragTypeForNode(dragType, node) {
         return dragType(node);
     return dragType !== null && dragType !== void 0 ? dragType : "NODE";
 }
+/* A node can start a drag only when it's draggable and not currently being
+   renamed. Without the editing guard, dragging inside the rename input would
+   pick the row up and move it (issue #195). */
+function canDragNode(node) {
+    return node.isDraggable && !node.isEditing;
+}
 function useDragHook(node) {
     const tree = (0, context_1.useTreeApi)();
     const ids = tree.selectedIds;
     const [_, ref, preview] = (0, react_dnd_1.useDrag)(() => ({
-        canDrag: () => node.isDraggable,
+        canDrag: () => canDragNode(node),
         type: dragTypeForNode(tree.props.dragType, node),
         item: () => {
             // This is fired once at the beginning of a drag operation

package/dist/main/dnd/drag-hook.test.js

@@ -17,3 +17,17 @@ test("resolves a per-node dragType function against the node", () => {
     expect((0, drag_hook_1.dragTypeForNode)(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
     expect((0, drag_hook_1.dragTypeForNode)(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
 });
+/* canDragNode only reads the isDraggable/isEditing flags, so a minimal stub
+   stands in for a real NodeApi. */
+function draggableNode(flags) {
+    return flags;
+}
+test("a draggable node that isn't being edited can drag", () => {
+    expect((0, drag_hook_1.canDragNode)(draggableNode({ isDraggable: true, isEditing: false }))).toBe(true);
+});
+test("a non-draggable node can't drag", () => {
+    expect((0, drag_hook_1.canDragNode)(draggableNode({ isDraggable: false, isEditing: false }))).toBe(false);
+});
+test("a node being renamed can't drag, even when draggable (#195)", () => {
+    expect((0, drag_hook_1.canDragNode)(draggableNode({ isDraggable: true, isEditing: true }))).toBe(false);
+});

package/dist/main/dnd/drop-hook.js

@@ -5,8 +5,6 @@ const react_dnd_1 = require("react-dnd");
 const context_1 = require("../context");
 const compute_drop_1 = require("./compute-drop");
 const dnd_slice_1 = require("../state/dnd-slice");
-const utils_1 = require("../utils");
-const create_root_1 = require("../data/create-root");
 function useDropHook(el, node) {
     const tree = (0, context_1.useTreeApi)();
     const [_, dropRef] = (0, react_dnd_1.useDrop)(() => ({
@@ -37,15 +35,7 @@ function useDropHook(el, node) {
         drop: (_, m) => {
             if (!m.canDrop())
                 return null;
-            let { parentId, index, dragIds } = tree.state.dnd;
-            (0, utils_1.safeRun)(tree.props.onMove, {
-                dragIds,
-                parentId: parentId === create_root_1.ROOT_ID ? null : parentId,
-                index: index === null ? 0 : index, // When it's null it was dropped over a folder
-                dragNodes: tree.dragNodes,
-                parentNode: tree.get(parentId),
-            });
-            tree.open(parentId);
+            tree.drop();
         },
     }), [node, el.current, tree.props]);
     return dropRef;

package/dist/main/dnd/outer-drop-hook.js

@@ -39,6 +39,13 @@ function useOuterDrop() {
                 tree.hideCursor();
             }
         },
+        drop: (_item, m) => {
+            if (!m.isOver({ shallow: true }))
+                return null;
+            if (!m.canDrop())
+                return null;
+            tree.drop();
+        },
     }), [tree]);
     drop(tree.listEl);
 }

package/dist/main/interfaces/tree-api.d.ts

@@ -205,6 +205,7 @@ export declare class TreeApi<T> {
     get dragDestinationParent(): NodeApi<T> | null;
     get dragDestinationIndex(): number | null;
     canDrop(): boolean;
+    drop(): void;
     hideCursor(): void;
     showCursor(cursor: Cursor): void;
     open(identity: Identity, redraw?: boolean): void;

package/dist/main/interfaces/tree-api.js

@@ -551,6 +551,17 @@ class TreeApi {
             return true;
         }
     }
+    drop() {
+        const { parentId, index, dragIds } = this.state.dnd;
+        safeRun(this.props.onMove, {
+            dragIds,
+            parentId: parentId === create_root_1.ROOT_ID ? null : parentId,
+            index: index === null ? 0 : index, // When it's null it was dropped over a folder
+            dragNodes: this.dragNodes,
+            parentNode: this.get(parentId),
+        });
+        this.open(parentId);
+    }
     hideCursor() {
         this.dispatch(dnd_slice_1.actions.cursor({ type: "none" }));
     }

package/dist/main/interfaces/tree-api.test.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const redux_1 = require("redux");
 const root_reducer_1 = require("../state/root-reducer");
+const dnd_slice_1 = require("../state/dnd-slice");
 const tree_api_1 = require("./tree-api");
 function setupApi(props) {
     const store = (0, redux_1.createStore)(root_reducer_1.rootReducer);
@@ -13,6 +14,30 @@ test("tree.canDrop()", () => {
     expect(setupApi({ disableDrop: false }).canDrop()).toBe(true);
 });
 const rowData = [{ id: "a" }, { id: "b" }, { id: "c" }];
+describe("tree.drop() fires onMove (#313)", () => {
+    test("reports the hovered parent and index, mapping the root id to null", () => {
+        const onMove = jest.fn();
+        const api = setupApi({ data: rowData, onMove });
+        // The bottom drop zone hovers the root with an index past the end, just like
+        // computeDrop() reports it. tree.drop() should map the root id back to null.
+        api.dispatch(dnd_slice_1.actions.dragStart("a", ["a"]));
+        api.dispatch(dnd_slice_1.actions.hovering(api.root.id, 3));
+        api.drop();
+        expect(onMove).toHaveBeenCalledTimes(1);
+        expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ dragIds: ["a"], parentId: null, index: 3 }));
+    });
+    test("coerces a null index (dropped onto a folder) to 0", () => {
+        const onMove = jest.fn();
+        const folderData = [{ id: "folder", children: [{ id: "child" }] }];
+        const api = setupApi({ data: folderData, onMove });
+        // Dropping onto a folder (rather than between rows) reports the folder as the
+        // parent with a null index, which tree.drop() should coerce to 0.
+        api.dispatch(dnd_slice_1.actions.dragStart("child", ["child"]));
+        api.dispatch(dnd_slice_1.actions.hovering("folder", null));
+        api.drop();
+        expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ parentId: "folder", index: 0 }));
+    });
+});
 test("rowHeight defaults to 24", () => {
     const api = setupApi({});
     expect(api.rowHeight).toBe(24);

package/dist/module/dnd/drag-hook.d.ts

@@ -2,4 +2,5 @@ import { ConnectDragSource } from "react-dnd";
 import { NodeApi } from "../interfaces/node-api";
 import { TreeProps } from "../types/tree-props";
 export declare function dragTypeForNode<T>(dragType: TreeProps<T>["dragType"], node: NodeApi<T>): string;
+export declare function canDragNode<T>(node: NodeApi<T>): boolean;
 export declare function useDragHook<T>(node: NodeApi<T>): ConnectDragSource;

package/dist/module/dnd/drag-hook.js

@@ -10,11 +10,17 @@ export function dragTypeForNode(dragType, node) {
         return dragType(node);
     return dragType !== null && dragType !== void 0 ? dragType : "NODE";
 }
+/* A node can start a drag only when it's draggable and not currently being
+   renamed. Without the editing guard, dragging inside the rename input would
+   pick the row up and move it (issue #195). */
+export function canDragNode(node) {
+    return node.isDraggable && !node.isEditing;
+}
 export function useDragHook(node) {
     const tree = useTreeApi();
     const ids = tree.selectedIds;
     const [_, ref, preview] = useDrag(() => ({
-        canDrag: () => node.isDraggable,
+        canDrag: () => canDragNode(node),
         type: dragTypeForNode(tree.props.dragType, node),
         item: () => {
             // This is fired once at the beginning of a drag operation

package/dist/module/dnd/drag-hook.test.js

@@ -1,4 +1,4 @@
-import { dragTypeForNode } from "./drag-hook";
+import { canDragNode, dragTypeForNode } from "./drag-hook";
 /* dragTypeForNode only reads node.data when dragType is a function, so a
    minimal stub stands in for a real NodeApi. */
 function nodeWith(data) {
@@ -15,3 +15,17 @@ test("resolves a per-node dragType function against the node", () => {
     expect(dragTypeForNode(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
     expect(dragTypeForNode(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
 });
+/* canDragNode only reads the isDraggable/isEditing flags, so a minimal stub
+   stands in for a real NodeApi. */
+function draggableNode(flags) {
+    return flags;
+}
+test("a draggable node that isn't being edited can drag", () => {
+    expect(canDragNode(draggableNode({ isDraggable: true, isEditing: false }))).toBe(true);
+});
+test("a non-draggable node can't drag", () => {
+    expect(canDragNode(draggableNode({ isDraggable: false, isEditing: false }))).toBe(false);
+});
+test("a node being renamed can't drag, even when draggable (#195)", () => {
+    expect(canDragNode(draggableNode({ isDraggable: true, isEditing: true }))).toBe(false);
+});

package/dist/module/dnd/drop-hook.js

@@ -2,8 +2,6 @@ import { useDrop } from "react-dnd";
 import { useTreeApi } from "../context";
 import { computeDrop } from "./compute-drop";
 import { actions as dnd } from "../state/dnd-slice";
-import { safeRun } from "../utils";
-import { ROOT_ID } from "../data/create-root";
 export function useDropHook(el, node) {
     const tree = useTreeApi();
     const [_, dropRef] = useDrop(() => ({
@@ -34,15 +32,7 @@ export function useDropHook(el, node) {
         drop: (_, m) => {
             if (!m.canDrop())
                 return null;
-            let { parentId, index, dragIds } = tree.state.dnd;
-            safeRun(tree.props.onMove, {
-                dragIds,
-                parentId: parentId === ROOT_ID ? null : parentId,
-                index: index === null ? 0 : index, // When it's null it was dropped over a folder
-                dragNodes: tree.dragNodes,
-                parentNode: tree.get(parentId),
-            });
-            tree.open(parentId);
+            tree.drop();
         },
     }), [node, el.current, tree.props]);
     return dropRef;

package/dist/module/dnd/outer-drop-hook.js

@@ -36,6 +36,13 @@ export function useOuterDrop() {
                 tree.hideCursor();
             }
         },
+        drop: (_item, m) => {
+            if (!m.isOver({ shallow: true }))
+                return null;
+            if (!m.canDrop())
+                return null;
+            tree.drop();
+        },
     }), [tree]);
     drop(tree.listEl);
 }

package/dist/module/interfaces/tree-api.d.ts

@@ -205,6 +205,7 @@ export declare class TreeApi<T> {
     get dragDestinationParent(): NodeApi<T> | null;
     get dragDestinationIndex(): number | null;
     canDrop(): boolean;
+    drop(): void;
     hideCursor(): void;
     showCursor(cursor: Cursor): void;
     open(identity: Identity, redraw?: boolean): void;

package/dist/module/interfaces/tree-api.js

@@ -525,6 +525,17 @@ export class TreeApi {
             return true;
         }
     }
+    drop() {
+        const { parentId, index, dragIds } = this.state.dnd;
+        safeRun(this.props.onMove, {
+            dragIds,
+            parentId: parentId === ROOT_ID ? null : parentId,
+            index: index === null ? 0 : index, // When it's null it was dropped over a folder
+            dragNodes: this.dragNodes,
+            parentNode: this.get(parentId),
+        });
+        this.open(parentId);
+    }
     hideCursor() {
         this.dispatch(dnd.cursor({ type: "none" }));
     }

package/dist/module/interfaces/tree-api.test.js

@@ -1,5 +1,6 @@
 import { createStore } from "redux";
 import { rootReducer } from "../state/root-reducer";
+import { actions as dnd } from "../state/dnd-slice";
 import { TreeApi } from "./tree-api";
 function setupApi(props) {
     const store = createStore(rootReducer);
@@ -11,6 +12,30 @@ test("tree.canDrop()", () => {
     expect(setupApi({ disableDrop: false }).canDrop()).toBe(true);
 });
 const rowData = [{ id: "a" }, { id: "b" }, { id: "c" }];
+describe("tree.drop() fires onMove (#313)", () => {
+    test("reports the hovered parent and index, mapping the root id to null", () => {
+        const onMove = jest.fn();
+        const api = setupApi({ data: rowData, onMove });
+        // The bottom drop zone hovers the root with an index past the end, just like
+        // computeDrop() reports it. tree.drop() should map the root id back to null.
+        api.dispatch(dnd.dragStart("a", ["a"]));
+        api.dispatch(dnd.hovering(api.root.id, 3));
+        api.drop();
+        expect(onMove).toHaveBeenCalledTimes(1);
+        expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ dragIds: ["a"], parentId: null, index: 3 }));
+    });
+    test("coerces a null index (dropped onto a folder) to 0", () => {
+        const onMove = jest.fn();
+        const folderData = [{ id: "folder", children: [{ id: "child" }] }];
+        const api = setupApi({ data: folderData, onMove });
+        // Dropping onto a folder (rather than between rows) reports the folder as the
+        // parent with a null index, which tree.drop() should coerce to 0.
+        api.dispatch(dnd.dragStart("child", ["child"]));
+        api.dispatch(dnd.hovering("folder", null));
+        api.drop();
+        expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ parentId: "folder", index: 0 }));
+    });
+});
 test("rowHeight defaults to 24", () => {
     const api = setupApi({});
     expect(api.rowHeight).toBe(24);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-arborist",
-  "version": "3.10.1",
+  "version": "3.10.3",
   "keywords": [
     "arborist",
     "dnd",

package/src/dnd/drag-hook.test.ts

@@ -1,5 +1,5 @@
 import { NodeApi } from "../interfaces/node-api";
-import { dragTypeForNode } from "./drag-hook";
+import { canDragNode, dragTypeForNode } from "./drag-hook";
 
 /* dragTypeForNode only reads node.data when dragType is a function, so a
    minimal stub stands in for a real NodeApi. */
@@ -20,3 +20,21 @@ test("resolves a per-node dragType function against the node", () => {
   expect(dragTypeForNode(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
   expect(dragTypeForNode(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
 });
+
+/* canDragNode only reads the isDraggable/isEditing flags, so a minimal stub
+   stands in for a real NodeApi. */
+function draggableNode(flags: { isDraggable: boolean; isEditing: boolean }): NodeApi {
+  return flags as NodeApi;
+}
+
+test("a draggable node that isn't being edited can drag", () => {
+  expect(canDragNode(draggableNode({ isDraggable: true, isEditing: false }))).toBe(true);
+});
+
+test("a non-draggable node can't drag", () => {
+  expect(canDragNode(draggableNode({ isDraggable: false, isEditing: false }))).toBe(false);
+});
+
+test("a node being renamed can't drag, even when draggable (#195)", () => {
+  expect(canDragNode(draggableNode({ isDraggable: true, isEditing: true }))).toBe(false);
+});

package/src/dnd/drag-hook.ts

@@ -15,12 +15,19 @@ export function dragTypeForNode<T>(dragType: TreeProps<T>["dragType"], node: Nod
   return dragType ?? "NODE";
 }
 
+/* A node can start a drag only when it's draggable and not currently being
+   renamed. Without the editing guard, dragging inside the rename input would
+   pick the row up and move it (issue #195). */
+export function canDragNode<T>(node: NodeApi<T>): boolean {
+  return node.isDraggable && !node.isEditing;
+}
+
 export function useDragHook<T>(node: NodeApi<T>): ConnectDragSource {
   const tree = useTreeApi<T>();
   const ids = tree.selectedIds;
   const [_, ref, preview] = useDrag<DragItem<T>, DropResult, void>(
     () => ({
-      canDrag: () => node.isDraggable,
+      canDrag: () => canDragNode(node),
       type: dragTypeForNode(tree.props.dragType, node),
       item: () => {
         // This is fired once at the beginning of a drag operation

package/src/dnd/drop-hook.ts

@@ -5,8 +5,6 @@ import { NodeApi } from "../interfaces/node-api";
 import { DragItem } from "../types/dnd";
 import { computeDrop } from "./compute-drop";
 import { actions as dnd } from "../state/dnd-slice";
-import { safeRun } from "../utils";
-import { ROOT_ID } from "../data/create-root";
 
 export type DropResult = {
   parentId: string | null;
@@ -43,15 +41,7 @@ export function useDropHook(
       },
       drop: (_, m) => {
         if (!m.canDrop()) return null;
-        let { parentId, index, dragIds } = tree.state.dnd;
-        safeRun(tree.props.onMove, {
-          dragIds,
-          parentId: parentId === ROOT_ID ? null : parentId,
-          index: index === null ? 0 : index, // When it's null it was dropped over a folder
-          dragNodes: tree.dragNodes,
-          parentNode: tree.get(parentId),
-        });
-        tree.open(parentId);
+        tree.drop();
       },
     }),
     [node, el.current, tree.props],

package/src/dnd/outer-drop-hook.ts

@@ -36,6 +36,11 @@ export function useOuterDrop() {
           tree.hideCursor();
         }
       },
+      drop: (_item, m) => {
+        if (!m.isOver({ shallow: true })) return null;
+        if (!m.canDrop()) return null;
+        tree.drop();
+      },
     }),
     [tree],
   );

package/src/interfaces/tree-api.test.ts

@@ -1,5 +1,6 @@
 import { createStore } from "redux";
 import { rootReducer } from "../state/root-reducer";
+import { actions as dnd } from "../state/dnd-slice";
 import { TreeProps } from "../types/tree-props";
 import { TreeApi } from "./tree-api";
 
@@ -16,6 +17,36 @@ test("tree.canDrop()", () => {
 
 const rowData = [{ id: "a" }, { id: "b" }, { id: "c" }];
 
+describe("tree.drop() fires onMove (#313)", () => {
+  test("reports the hovered parent and index, mapping the root id to null", () => {
+    const onMove = jest.fn();
+    const api = setupApi({ data: rowData, onMove });
+    // The bottom drop zone hovers the root with an index past the end, just like
+    // computeDrop() reports it. tree.drop() should map the root id back to null.
+    api.dispatch(dnd.dragStart("a", ["a"]));
+    api.dispatch(dnd.hovering(api.root.id, 3));
+    api.drop();
+    expect(onMove).toHaveBeenCalledTimes(1);
+    expect(onMove).toHaveBeenCalledWith(
+      expect.objectContaining({ dragIds: ["a"], parentId: null, index: 3 }),
+    );
+  });
+
+  test("coerces a null index (dropped onto a folder) to 0", () => {
+    const onMove = jest.fn();
+    const folderData = [{ id: "folder", children: [{ id: "child" }] }];
+    const api = setupApi({ data: folderData, onMove });
+    // Dropping onto a folder (rather than between rows) reports the folder as the
+    // parent with a null index, which tree.drop() should coerce to 0.
+    api.dispatch(dnd.dragStart("child", ["child"]));
+    api.dispatch(dnd.hovering("folder", null));
+    api.drop();
+    expect(onMove).toHaveBeenCalledWith(
+      expect.objectContaining({ parentId: "folder", index: 0 }),
+    );
+  });
+});
+
 test("rowHeight defaults to 24", () => {
   const api = setupApi({});
   expect(api.rowHeight).toBe(24);

package/src/interfaces/tree-api.ts

@@ -546,6 +546,18 @@ export class TreeApi<T> {
     }
   }
 
+  drop() {
+    const { parentId, index, dragIds } = this.state.dnd;
+    safeRun(this.props.onMove, {
+      dragIds,
+      parentId: parentId === ROOT_ID ? null : parentId,
+      index: index === null ? 0 : index, // When it's null it was dropped over a folder
+      dragNodes: this.dragNodes,
+      parentNode: this.get(parentId),
+    });
+    this.open(parentId);
+  }
+
   hideCursor() {
     this.dispatch(dnd.cursor({ type: "none" }));
   }