react-arborist 3.10.4 → 3.10.6

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

@@ -11,6 +11,7 @@ import * as utils from "../utils";
 import { DefaultCursor } from "../components/default-cursor";
 import { DefaultRow } from "../components/default-row";
 import { DefaultNode } from "../components/default-node";
+import { NodeApi } from "./node-api";
 import { edit } from "../state/edit-slice";
 import { focus, treeBlur } from "../state/focus-slice";
 import { createRoot, ROOT_ID } from "../data/create-root";
@@ -21,7 +22,7 @@ import { DefaultDragPreview } from "../components/default-drag-preview";
 import { DefaultContainer } from "../components/default-container";
 import { createList } from "../data/create-list";
 import { createIndex } from "../data/create-index";
-const { safeRun, identify, identifyNull } = utils;
+const { safeRun } = utils;
 export class TreeApi {
     constructor(store, props, list, listEl) {
         this.store = store;
@@ -163,6 +164,30 @@ export class TreeApi {
             throw new Error("Data must contain an 'id' property or props.idAccessor must return a string");
         return id;
     }
+    /**
+     * Resolve an identifier to a node id. Public methods accept an id string, a
+     * NodeApi, or the raw row data; this is the one place that turns any of those
+     * into the string id used internally. Raw data is run through the configured
+     * `idAccessor` so a custom accessor (e.g. `uuid`) is honored everywhere, not
+     * just where nodes were built. A NodeApi already carries its accessor-derived
+     * `id`, so it is used directly rather than re-accessed (the accessor reads the
+     * underlying data, which a NodeApi does not expose under that key). Unlike
+     * `accessId`, an unresolved id comes back as `undefined` rather than throwing,
+     * preserving the previous behavior of the `id`-only lookup.
+     */
+    identify(identity) {
+        if (typeof identity === "string")
+            return identity;
+        if (identity instanceof NodeApi)
+            return identity.id;
+        const get = this.props.idAccessor || "id";
+        return utils.access(identity, get);
+    }
+    identifyNull(identity) {
+        if (identity === null || identity === undefined)
+            return null;
+        return this.identify(identity);
+    }
     /* Node Access */
     get firstNode() {
         var _a;
@@ -218,7 +243,7 @@ export class TreeApi {
         return this.visibleNodes.slice(start, end + 1);
     }
     indexOf(id) {
-        const key = utils.identifyNull(id);
+        const key = this.identifyNull(id);
         if (!key)
             return null;
         return this.idToIndex[key];
@@ -261,7 +286,7 @@ export class TreeApi {
             if (!node)
                 return;
             const idents = Array.isArray(node) ? node : [node];
-            const ids = idents.map(identify);
+            const ids = idents.map((i) => this.identify(i));
             const nodes = ids.map((id) => this.get(id)).filter((n) => !!n);
             /* Guard against Math.min(...[]) === Infinity when no ids resolve to nodes. */
             const fromIndex = nodes.length ? Math.min(...nodes.map((n) => { var _a; return (_a = n.rowIndex) !== null && _a !== void 0 ? _a : 0; })) : 0;
@@ -271,7 +296,7 @@ export class TreeApi {
     }
     edit(node) {
         var _a, _b;
-        const id = identify(node);
+        const id = this.identify(node);
         this.resolveEdit({ cancelled: true });
         this.scrollTo(id);
         this.dispatch(edit(id));
@@ -285,7 +310,7 @@ export class TreeApi {
             var _a, _b;
             if (!identity)
                 return;
-            const id = identify(identity);
+            const id = this.identify(identity);
             yield safeRun(this.props.onRename, {
                 id,
                 name: value,
@@ -304,7 +329,7 @@ export class TreeApi {
         setTimeout(() => this.onFocus()); // Return focus to element;
     }
     activate(id) {
-        const node = this.get(identifyNull(id));
+        const node = this.get(this.identifyNull(id));
         if (!node)
             return;
         safeRun(this.props.onActivate, node);
@@ -338,7 +363,7 @@ export class TreeApi {
             this.select(node);
         }
         else {
-            this.dispatch(focus(identify(node)));
+            this.dispatch(focus(this.identify(node)));
             if (opts.scroll !== false)
                 this.scrollTo(node);
             if (this.focusedNode)
@@ -378,7 +403,7 @@ export class TreeApi {
         if (!node)
             return;
         const changeFocus = opts.focus !== false;
-        const id = identify(node);
+        const id = this.identify(node);
         if (changeFocus)
             this.dispatch(focus(id));
         if ((_a = this.get(id)) === null || _a === void 0 ? void 0 : _a.isSelectable) {
@@ -396,12 +421,12 @@ export class TreeApi {
     deselect(node) {
         if (!node)
             return;
-        const id = identify(node);
+        const id = this.identify(node);
         this.dispatch(selection.remove(id));
         safeRun(this.props.onSelect, this.selectedNodes);
     }
     selectMulti(identity, opts = {}) {
-        const node = this.get(identifyNull(identity));
+        const node = this.get(this.identifyNull(identity));
         if (!node)
             return;
         const changeFocus = opts.focus !== false;
@@ -422,11 +447,11 @@ export class TreeApi {
         var _a;
         if (!identity)
             return;
-        const id = identify(identity);
+        const id = this.identify(identity);
         this.dispatch(focus(id));
         if ((_a = this.get(id)) === null || _a === void 0 ? void 0 : _a.isSelectable) {
             const { anchor, mostRecent } = this.state.nodes.selection;
-            const selectableNodes = this.filterSelectableNodes(this.nodesBetween(anchor, identifyNull(id)));
+            const selectableNodes = this.filterSelectableNodes(this.nodesBetween(anchor, this.identifyNull(id)));
             this.dispatch(selection.remove(this.nodesBetween(anchor, mostRecent)));
             this.dispatch(selection.add(selectableNodes));
             this.dispatch(selection.mostRecent(id));
@@ -455,14 +480,14 @@ export class TreeApi {
     }
     filterSelectableNodes(nodes) {
         return nodes
-            .map((n) => this.get(identify(n)))
+            .map((n) => this.get(this.identify(n)))
             .filter((n) => !!n && n.isSelectable);
     }
     setSelection(args) {
         var _a;
-        const ids = new Set((_a = args.ids) === null || _a === void 0 ? void 0 : _a.map(identify));
-        const anchor = identifyNull(args.anchor);
-        const mostRecent = identifyNull(args.mostRecent);
+        const ids = new Set((_a = args.ids) === null || _a === void 0 ? void 0 : _a.map((i) => this.identify(i)));
+        const anchor = this.identifyNull(args.anchor);
+        const mostRecent = this.identifyNull(args.mostRecent);
         this.dispatch(selection.set({ ids, anchor, mostRecent }));
         safeRun(this.props.onSelect, this.selectedNodes);
     }
@@ -545,7 +570,7 @@ export class TreeApi {
     /* Visibility */
     open(identity, redraw = true) {
         var _a, _b;
-        const id = identifyNull(identity);
+        const id = this.identifyNull(identity);
         if (!id)
             return;
         if (this.isOpen(id))
@@ -557,7 +582,7 @@ export class TreeApi {
     }
     close(identity, redraw = true) {
         var _a, _b;
-        const id = identifyNull(identity);
+        const id = this.identifyNull(identity);
         if (!id)
             return;
         if (!this.isOpen(id))
@@ -568,13 +593,13 @@ export class TreeApi {
         safeRun(this.props.onToggle, id);
     }
     toggle(identity) {
-        const id = identifyNull(identity);
+        const id = this.identifyNull(identity);
         if (!id)
             return;
         return this.isOpen(id) ? this.close(id) : this.open(id);
     }
     openParents(identity) {
-        const id = identifyNull(identity);
+        const id = this.identifyNull(identity);
         if (!id)
             return;
         const node = utils.dfs(this.root, id);
@@ -622,7 +647,7 @@ export class TreeApi {
     scrollTo(identity, align = "smart") {
         if (!identity)
             return;
-        const id = identify(identity);
+        const id = this.identify(identity);
         this.openParents(id);
         return utils
             .waitFor(() => id in this.idToIndex)
@@ -632,11 +657,38 @@ export class TreeApi {
             if (index === undefined)
                 return;
             (_a = this.list.current) === null || _a === void 0 ? void 0 : _a.scrollToItem(index, align);
+            /* react-window only scrolls vertically. A deeply nested node is
+               indented by level * indent and can sit past the right edge when rows
+               overflow horizontally, so bring it into view ourselves (#220). */
+            this.scrollToNodeHorizontally(this.get(id));
         })
             .catch(() => {
             // Id: ${id} never appeared in the list.
         });
     }
+    /**
+     * Horizontally scroll the list so the node's indented content is in view.
+     * A no-op when the list doesn't overflow horizontally (the common case), so
+     * it never disturbs scrolling for trees that fit their width.
+     */
+    scrollToNodeHorizontally(node) {
+        const el = this.listEl.current;
+        if (!node || !el)
+            return;
+        const maxScroll = el.scrollWidth - el.clientWidth;
+        if (maxScroll <= 0)
+            return; // nothing to scroll
+        const left = node.level * this.indent;
+        const viewLeft = el.scrollLeft;
+        const viewRight = el.scrollLeft + el.clientWidth;
+        /* The visible range is half-open [viewLeft, viewRight): a pixel at viewRight
+           is already clipped. Only move when the node's indentation falls outside
+           it, aligning its content start to the left edge so the label is revealed,
+           clamped to the list's scrollable range. */
+        if (left < viewLeft || left >= viewRight) {
+            el.scrollLeft = Math.max(0, Math.min(left, maxScroll));
+        }
+    }
     /* State Checks */
     get isEditing() {
         return this.state.nodes.edit.id !== null;
@@ -689,7 +741,7 @@ export class TreeApi {
         return !utils.access(data, disabler);
     }
     isDragging(node) {
-        const id = identifyNull(node);
+        const id = this.identifyNull(node);
         if (!id)
             return false;
         return this.state.nodes.drag.id === id;
@@ -701,7 +753,7 @@ export class TreeApi {
         return this.matchFn(node);
     }
     willReceiveDrop(node) {
-        const id = identifyNull(node);
+        const id = this.identifyNull(node);
         if (!id)
             return false;
         const { destinationParentId, destinationIndex } = this.state.nodes.drag;

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

@@ -1,3 +1,12 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { createStore } from "redux";
 import { rootReducer } from "../state/root-reducer";
 import { actions as dnd } from "../state/dnd-slice";
@@ -36,6 +45,45 @@ describe("tree.drop() fires onMove (#313)", () => {
         expect(onMove).toHaveBeenCalledWith(expect.objectContaining({ parentId: "folder", index: 0 }));
     });
 });
+describe("custom idAccessor is honored when methods receive raw data (#347)", () => {
+    const uuidData = [{ uuid: "a" }, { uuid: "b" }, { uuid: "c" }];
+    test("select(data) resolves the id through idAccessor", () => {
+        const onSelect = jest.fn();
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onSelect });
+        api.select(uuidData[1]);
+        expect(api.selectedIds.has("b")).toBe(true);
+        expect(api.selectedNodes.map((n) => n.id)).toEqual(["b"]);
+    });
+    test("focus(data) resolves the id through idAccessor", () => {
+        var _a;
+        const api = setupApi({ data: uuidData, idAccessor: "uuid" });
+        api.focus(uuidData[2]);
+        expect((_a = api.focusedNode) === null || _a === void 0 ? void 0 : _a.id).toBe("c");
+    });
+    test("delete(data) passes the accessor-derived id to onDelete", () => {
+        const onDelete = jest.fn();
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onDelete });
+        api.delete(uuidData[0]);
+        expect(onDelete).toHaveBeenCalledWith(expect.objectContaining({ ids: ["a"] }));
+    });
+    test("create() focuses the new node by its accessor-derived id", () => __awaiter(void 0, void 0, void 0, function* () {
+        // create() passes the raw row data returned by onCreate straight to
+        // focus/edit/select; before the fix these read `.id` and lost the node.
+        const onCreate = () => ({ uuid: "new" });
+        const api = setupApi({ data: uuidData, idAccessor: "uuid", onCreate });
+        yield api.create();
+        expect(api.state.nodes.focus.id).toBe("new");
+    }));
+    test("a function idAccessor is honored too", () => {
+        const fnData = [{ meta: { key: "x" } }, { meta: { key: "y" } }];
+        const api = setupApi({
+            data: fnData,
+            idAccessor: (d) => d.meta.key,
+        });
+        api.select(fnData[1]);
+        expect(api.selectedIds.has("y")).toBe(true);
+    });
+});
 test("rowHeight defaults to 24", () => {
     const api = setupApi({});
     expect(api.rowHeight).toBe(24);
@@ -117,3 +165,55 @@ describe("onSelect fires exactly once per selection method (#332)", () => {
         expect(onSelect).toHaveBeenCalledTimes(1);
     });
 });
+describe("scrollTo brings a deeply nested node into view horizontally (#220)", () => {
+    // A folder tree where "deep" sits at level 2 (indented 2 * 24 = 48px).
+    const nestedData = [{ id: "root", children: [{ id: "mid", children: [{ id: "deep" }] }] }];
+    // react-window's scrollToItem only scrolls vertically; the horizontal scroll
+    // happens on the outer list element, which we stub here.
+    function setupWithListEl(el) {
+        const store = createStore(rootReducer);
+        const list = { current: { scrollToItem: jest.fn() } };
+        const listEl = { current: el };
+        return new TreeApi(store, { data: nestedData }, list, listEl);
+    }
+    test("scrolls right when the node is past the right edge", () => __awaiter(void 0, void 0, void 0, function* () {
+        const el = { scrollWidth: 500, clientWidth: 40, scrollLeft: 0 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        // Aligns the node's indentation start (level 2 * indent 24) to the left edge.
+        expect(el.scrollLeft).toBe(48);
+    }));
+    test("scrolls left when the node is past the left edge", () => __awaiter(void 0, void 0, void 0, function* () {
+        const el = { scrollWidth: 500, clientWidth: 100, scrollLeft: 200 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        expect(el.scrollLeft).toBe(48);
+    }));
+    test("scrolls when the node's start sits exactly on the right edge", () => __awaiter(void 0, void 0, void 0, function* () {
+        // viewRight === left (48): the visible range is half-open, so the content
+        // start is already clipped and must be scrolled into view.
+        const el = { scrollWidth: 500, clientWidth: 48, scrollLeft: 0 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        expect(el.scrollLeft).toBe(48);
+    }));
+    test("clamps the target to the maximum scrollable distance", () => __awaiter(void 0, void 0, void 0, function* () {
+        // left (48) exceeds maxScroll (60 - 40 = 20), so scrollLeft is clamped.
+        const el = { scrollWidth: 60, clientWidth: 40, scrollLeft: 0 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        expect(el.scrollLeft).toBe(20);
+    }));
+    test("leaves scroll untouched when the node is already in view", () => __awaiter(void 0, void 0, void 0, function* () {
+        const el = { scrollWidth: 500, clientWidth: 200, scrollLeft: 0 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        expect(el.scrollLeft).toBe(0);
+    }));
+    test("no-ops when the list does not overflow horizontally", () => __awaiter(void 0, void 0, void 0, function* () {
+        const el = { scrollWidth: 100, clientWidth: 100, scrollLeft: 0 };
+        const api = setupWithListEl(el);
+        yield api.scrollTo("deep");
+        expect(el.scrollLeft).toBe(0);
+    }));
+});

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

@@ -5,7 +5,7 @@ export type CreateHandler<T> = (args: {
     parentNode: NodeApi<T> | null;
     index: number;
     type: "internal" | "leaf";
-}) => (IdObj | null) | Promise<IdObj | null>;
+}) => (T | IdObj | null) | Promise<T | IdObj | null>;
 export type MoveHandler<T> = (args: {
     dragIds: string[];
     dragNodes: NodeApi<T>[];

package/package.json

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

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

@@ -47,6 +47,52 @@ describe("tree.drop() fires onMove (#313)", () => {
   });
 });
 
+describe("custom idAccessor is honored when methods receive raw data (#347)", () => {
+  const uuidData = [{ uuid: "a" }, { uuid: "b" }, { uuid: "c" }];
+
+  test("select(data) resolves the id through idAccessor", () => {
+    const onSelect = jest.fn();
+    const api = setupApi({ data: uuidData, idAccessor: "uuid", onSelect });
+    api.select(uuidData[1]);
+    expect(api.selectedIds.has("b")).toBe(true);
+    expect(api.selectedNodes.map((n) => n.id)).toEqual(["b"]);
+  });
+
+  test("focus(data) resolves the id through idAccessor", () => {
+    const api = setupApi({ data: uuidData, idAccessor: "uuid" });
+    api.focus(uuidData[2]);
+    expect(api.focusedNode?.id).toBe("c");
+  });
+
+  test("delete(data) passes the accessor-derived id to onDelete", () => {
+    const onDelete = jest.fn();
+    const api = setupApi({ data: uuidData, idAccessor: "uuid", onDelete });
+    api.delete(uuidData[0]);
+    expect(onDelete).toHaveBeenCalledWith(
+      expect.objectContaining({ ids: ["a"] }),
+    );
+  });
+
+  test("create() focuses the new node by its accessor-derived id", async () => {
+    // create() passes the raw row data returned by onCreate straight to
+    // focus/edit/select; before the fix these read `.id` and lost the node.
+    const onCreate = () => ({ uuid: "new" });
+    const api = setupApi({ data: uuidData, idAccessor: "uuid", onCreate });
+    await api.create();
+    expect(api.state.nodes.focus.id).toBe("new");
+  });
+
+  test("a function idAccessor is honored too", () => {
+    const fnData = [{ meta: { key: "x" } }, { meta: { key: "y" } }];
+    const api = setupApi({
+      data: fnData,
+      idAccessor: (d: any) => d.meta.key,
+    });
+    api.select(fnData[1]);
+    expect(api.selectedIds.has("y")).toBe(true);
+  });
+});
+
 test("rowHeight defaults to 24", () => {
   const api = setupApi({});
   expect(api.rowHeight).toBe(24);
@@ -138,3 +184,63 @@ describe("onSelect fires exactly once per selection method (#332)", () => {
     expect(onSelect).toHaveBeenCalledTimes(1);
   });
 });
+
+describe("scrollTo brings a deeply nested node into view horizontally (#220)", () => {
+  // A folder tree where "deep" sits at level 2 (indented 2 * 24 = 48px).
+  const nestedData = [{ id: "root", children: [{ id: "mid", children: [{ id: "deep" }] }] }];
+
+  // react-window's scrollToItem only scrolls vertically; the horizontal scroll
+  // happens on the outer list element, which we stub here.
+  function setupWithListEl(el: Partial<HTMLDivElement>) {
+    const store = createStore(rootReducer);
+    const list = { current: { scrollToItem: jest.fn() } as any };
+    const listEl = { current: el as HTMLDivElement };
+    return new TreeApi(store, { data: nestedData }, list, listEl);
+  }
+
+  test("scrolls right when the node is past the right edge", async () => {
+    const el = { scrollWidth: 500, clientWidth: 40, scrollLeft: 0 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    // Aligns the node's indentation start (level 2 * indent 24) to the left edge.
+    expect(el.scrollLeft).toBe(48);
+  });
+
+  test("scrolls left when the node is past the left edge", async () => {
+    const el = { scrollWidth: 500, clientWidth: 100, scrollLeft: 200 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    expect(el.scrollLeft).toBe(48);
+  });
+
+  test("scrolls when the node's start sits exactly on the right edge", async () => {
+    // viewRight === left (48): the visible range is half-open, so the content
+    // start is already clipped and must be scrolled into view.
+    const el = { scrollWidth: 500, clientWidth: 48, scrollLeft: 0 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    expect(el.scrollLeft).toBe(48);
+  });
+
+  test("clamps the target to the maximum scrollable distance", async () => {
+    // left (48) exceeds maxScroll (60 - 40 = 20), so scrollLeft is clamped.
+    const el = { scrollWidth: 60, clientWidth: 40, scrollLeft: 0 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    expect(el.scrollLeft).toBe(20);
+  });
+
+  test("leaves scroll untouched when the node is already in view", async () => {
+    const el = { scrollWidth: 500, clientWidth: 200, scrollLeft: 0 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    expect(el.scrollLeft).toBe(0);
+  });
+
+  test("no-ops when the list does not overflow horizontally", async () => {
+    const el = { scrollWidth: 100, clientWidth: 100, scrollLeft: 0 };
+    const api = setupWithListEl(el);
+    await api.scrollTo("deep");
+    expect(el.scrollLeft).toBe(0);
+  });
+});