react-arborist 3.8.0 → 3.9.0

package/README.md

@@ -351,9 +351,23 @@ interface TreeProps<T> {
     { backend: unknown }
   >["backend"];
   dndManager?: ReturnType<typeof useDragDropManager>;
+  dragType?: string | ((node: NodeApi<T>) => string);
 }
 ```
 
+### Dragging Nodes to External Drop Targets
+
+The react-dnd drag item created for each row carries the dragged node's `data`, so a drop target rendered outside the tree can read it:
+
+```tsx
+const [, drop] = useDrop(() => ({
+  accept: "NODE",
+  drop: (item) => console.log(item.data), // the dragged node's data
+}));
+```
+
+The tree and your external target must share one react-dnd backend. Wrap both in a single `DndProvider` and pass its manager to the tree via the `dndManager` prop. By default rows advertise the `"NODE"` item type; set the `dragType` prop (a fixed string, or a function of the node) to advertise a custom type instead. Note that the tree's own drop targets only accept `"NODE"`, so a row given a custom `dragType` is no longer reorderable within the tree.
+
 ## Row Component Props
 
 The _\<RowRenderer\>_ is responsible for attaching the drop ref, the row style (top, height) and the aria-attributes. The default should work fine for most use cases, but it can be replaced by your own component if you need. See the _renderRow_ prop in the _\<Tree\>_ component.

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

@@ -1,3 +1,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 useDragHook<T>(node: NodeApi<T>): ConnectDragSource;

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

@@ -1,29 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.dragTypeForNode = dragTypeForNode;
 exports.useDragHook = useDragHook;
 const react_1 = require("react");
 const react_dnd_1 = require("react-dnd");
 const react_dnd_html5_backend_1 = require("react-dnd-html5-backend");
 const context_1 = require("../context");
 const dnd_slice_1 = require("../state/dnd-slice");
+/* The react-dnd item type a row's drag source broadcasts. The dragType prop
+   can be a fixed string or a per-node function; it defaults to "NODE". */
+function dragTypeForNode(dragType, node) {
+    if (typeof dragType === "function")
+        return dragType(node);
+    return dragType !== null && dragType !== void 0 ? dragType : "NODE";
+}
 function useDragHook(node) {
     const tree = (0, context_1.useTreeApi)();
     const ids = tree.selectedIds;
     const [_, ref, preview] = (0, react_dnd_1.useDrag)(() => ({
         canDrag: () => node.isDraggable,
-        type: "NODE",
+        type: dragTypeForNode(tree.props.dragType, node),
         item: () => {
-            // This is fired once at the begging of a drag operation
+            // This is fired once at the beginning of a drag operation
             const dragIds = tree.isSelected(node.id) ? Array.from(ids) : [node.id];
             tree.dispatch(dnd_slice_1.actions.dragStart(node.id, dragIds));
-            return { id: node.id, dragIds };
+            return { id: node.id, dragIds, data: node.data };
         },
         end: () => {
             tree.hideCursor();
             tree.redrawList();
             tree.dispatch(dnd_slice_1.actions.dragEnd());
         },
-    }), [ids, node]);
+    }), [ids, node, tree.props.dragType]);
     (0, react_1.useEffect)(() => {
         preview((0, react_dnd_html5_backend_1.getEmptyImage)());
     }, [preview]);

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

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

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

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const drag_hook_1 = require("./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) {
+    return { data };
+}
+test("defaults to the internal NODE type when dragType is undefined", () => {
+    expect((0, drag_hook_1.dragTypeForNode)(undefined, nodeWith({ id: "a" }))).toBe("NODE");
+});
+test("uses a fixed string dragType for every node", () => {
+    expect((0, drag_hook_1.dragTypeForNode)("FILE", nodeWith({ id: "a" }))).toBe("FILE");
+});
+test("resolves a per-node dragType function against the node", () => {
+    const dragType = (node) => node.data.kind.toUpperCase();
+    expect((0, drag_hook_1.dragTypeForNode)(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
+    expect((0, drag_hook_1.dragTypeForNode)(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
+});

package/dist/main/types/dnd.d.ts

@@ -3,6 +3,8 @@ export type CursorLocation = {
     level: number | null;
     parentId: string | null;
 };
-export type DragItem = {
+export type DragItem<T = any> = {
     id: string;
+    dragIds: string[];
+    data: T;
 };

package/dist/main/types/tree-props.d.ts

@@ -59,6 +59,7 @@ export interface TreeProps<T> {
         backend: unknown;
     }>["backend"];
     dndManager?: ReturnType<typeof useDragDropManager>;
+    dragType?: string | ((node: NodeApi<T>) => string);
     outerElementType?: ReactWindowCommonProps["outerElementType"];
     innerElementType?: ReactWindowCommonProps["innerElementType"];
 }

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

@@ -1,3 +1,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 useDragHook<T>(node: NodeApi<T>): ConnectDragSource;

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

@@ -3,24 +3,31 @@ import { useDrag } from "react-dnd";
 import { getEmptyImage } from "react-dnd-html5-backend";
 import { useTreeApi } from "../context";
 import { actions as dnd } from "../state/dnd-slice";
+/* The react-dnd item type a row's drag source broadcasts. The dragType prop
+   can be a fixed string or a per-node function; it defaults to "NODE". */
+export function dragTypeForNode(dragType, node) {
+    if (typeof dragType === "function")
+        return dragType(node);
+    return dragType !== null && dragType !== void 0 ? dragType : "NODE";
+}
 export function useDragHook(node) {
     const tree = useTreeApi();
     const ids = tree.selectedIds;
     const [_, ref, preview] = useDrag(() => ({
         canDrag: () => node.isDraggable,
-        type: "NODE",
+        type: dragTypeForNode(tree.props.dragType, node),
         item: () => {
-            // This is fired once at the begging of a drag operation
+            // This is fired once at the beginning of a drag operation
             const dragIds = tree.isSelected(node.id) ? Array.from(ids) : [node.id];
             tree.dispatch(dnd.dragStart(node.id, dragIds));
-            return { id: node.id, dragIds };
+            return { id: node.id, dragIds, data: node.data };
         },
         end: () => {
             tree.hideCursor();
             tree.redrawList();
             tree.dispatch(dnd.dragEnd());
         },
-    }), [ids, node]);
+    }), [ids, node, tree.props.dragType]);
     useEffect(() => {
         preview(getEmptyImage());
     }, [preview]);

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

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

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

@@ -0,0 +1,17 @@
+import { 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) {
+    return { data };
+}
+test("defaults to the internal NODE type when dragType is undefined", () => {
+    expect(dragTypeForNode(undefined, nodeWith({ id: "a" }))).toBe("NODE");
+});
+test("uses a fixed string dragType for every node", () => {
+    expect(dragTypeForNode("FILE", nodeWith({ id: "a" }))).toBe("FILE");
+});
+test("resolves a per-node dragType function against the node", () => {
+    const dragType = (node) => node.data.kind.toUpperCase();
+    expect(dragTypeForNode(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
+    expect(dragTypeForNode(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
+});

package/dist/module/types/dnd.d.ts

@@ -3,6 +3,8 @@ export type CursorLocation = {
     level: number | null;
     parentId: string | null;
 };
-export type DragItem = {
+export type DragItem<T = any> = {
     id: string;
+    dragIds: string[];
+    data: T;
 };

package/dist/module/types/tree-props.d.ts

@@ -59,6 +59,7 @@ export interface TreeProps<T> {
         backend: unknown;
     }>["backend"];
     dndManager?: ReturnType<typeof useDragDropManager>;
+    dragType?: string | ((node: NodeApi<T>) => string);
     outerElementType?: ReactWindowCommonProps["outerElementType"];
     innerElementType?: ReactWindowCommonProps["innerElementType"];
 }

package/package.json

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

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

@@ -0,0 +1,22 @@
+import { NodeApi } from "../interfaces/node-api";
+import { 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<T>(data: T): NodeApi<T> {
+  return { data } as NodeApi<T>;
+}
+
+test("defaults to the internal NODE type when dragType is undefined", () => {
+  expect(dragTypeForNode(undefined, nodeWith({ id: "a" }))).toBe("NODE");
+});
+
+test("uses a fixed string dragType for every node", () => {
+  expect(dragTypeForNode("FILE", nodeWith({ id: "a" }))).toBe("FILE");
+});
+
+test("resolves a per-node dragType function against the node", () => {
+  const dragType = (node: NodeApi<{ kind: string }>) => node.data.kind.toUpperCase();
+  expect(dragTypeForNode(dragType, nodeWith({ kind: "folder" }))).toBe("FOLDER");
+  expect(dragTypeForNode(dragType, nodeWith({ kind: "file" }))).toBe("FILE");
+});

package/src/dnd/drag-hook.ts

@@ -4,21 +4,29 @@ import { getEmptyImage } from "react-dnd-html5-backend";
 import { useTreeApi } from "../context";
 import { NodeApi } from "../interfaces/node-api";
 import { DragItem } from "../types/dnd";
+import { TreeProps } from "../types/tree-props";
 import { DropResult } from "./drop-hook";
 import { actions as dnd } from "../state/dnd-slice";
 
+/* The react-dnd item type a row's drag source broadcasts. The dragType prop
+   can be a fixed string or a per-node function; it defaults to "NODE". */
+export function dragTypeForNode<T>(dragType: TreeProps<T>["dragType"], node: NodeApi<T>): string {
+  if (typeof dragType === "function") return dragType(node);
+  return dragType ?? "NODE";
+}
+
 export function useDragHook<T>(node: NodeApi<T>): ConnectDragSource {
-  const tree = useTreeApi();
+  const tree = useTreeApi<T>();
   const ids = tree.selectedIds;
-  const [_, ref, preview] = useDrag<DragItem, DropResult, void>(
+  const [_, ref, preview] = useDrag<DragItem<T>, DropResult, void>(
     () => ({
       canDrag: () => node.isDraggable,
-      type: "NODE",
+      type: dragTypeForNode(tree.props.dragType, node),
       item: () => {
-        // This is fired once at the begging of a drag operation
+        // This is fired once at the beginning of a drag operation
         const dragIds = tree.isSelected(node.id) ? Array.from(ids) : [node.id];
         tree.dispatch(dnd.dragStart(node.id, dragIds));
-        return { id: node.id, dragIds };
+        return { id: node.id, dragIds, data: node.data };
       },
       end: () => {
         tree.hideCursor();
@@ -26,7 +34,7 @@ export function useDragHook<T>(node: NodeApi<T>): ConnectDragSource {
         tree.dispatch(dnd.dragEnd());
       },
     }),
-    [ids, node],
+    [ids, node, tree.props.dragType],
   );
 
   useEffect(() => {

package/src/types/dnd.ts

@@ -4,6 +4,11 @@ export type CursorLocation = {
   parentId: string | null;
 };
 
-export type DragItem = {
+export type DragItem<T = any> = {
+  /* The id of the row the drag started on. */
   id: string;
+  /* Every node carried by the drag (the selection, or just `id`). */
+  dragIds: string[];
+  /* The dragged node's data, so external drop targets can read it. */
+  data: T;
 };

package/src/types/tree-props.ts

@@ -79,6 +79,15 @@ export interface TreeProps<T> {
   dndBackend?: Extract<DndProviderProps<unknown, unknown>, { backend: unknown }>["backend"];
   dndManager?: ReturnType<typeof useDragDropManager>;
 
+  /* The react-dnd item type each row's drag source advertises. Defaults to
+     "NODE". Set a custom value (or a per-node function) so rows can be dropped
+     onto external react-dnd targets that accept that type. The dragged node's
+     data is always exposed on the drag item, so an external target accepting
+     the default "NODE" type can read it without setting this. Note: the tree's
+     own drop targets only accept "NODE", so a row given a custom type is no
+     longer reorderable within the tree. */
+  dragType?: string | ((node: NodeApi<T>) => string);
+
   /* Custom react-window outer/inner elements */
   outerElementType?: ReactWindowCommonProps["outerElementType"];
   innerElementType?: ReactWindowCommonProps["innerElementType"];