Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

Output item selector on tree drag end (#1257)

Bogdan Chadkinaaffa9019e4d
diff --git a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
index 0cbc084ff8..b61e49e682 100644
--- a/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/navigator/navigator.tsx
@@ -11,7 +11,10 @@ import {
import { InstanceTree } from "~/builder/shared/tree";
import { reparentInstance } from "~/shared/instance-utils";
import { Header, CloseButton } from "../header";
-import { getInstanceSelector } from "~/shared/tree-utils";
+import {
+ getInstanceSelector,
+ type InstanceSelector,
+} from "~/shared/tree-utils";
type NavigatorProps = {
isClosable?: boolean;
@@ -30,10 +33,10 @@ export const Navigator = ({ isClosable, onClose }: NavigatorProps) => {
const handleDragEnd = useCallback(
(payload: {
- itemId: string;
+ itemSelector: InstanceSelector;
dropTarget: { itemId: string; position: number | "end" };
}) => {
- reparentInstance(payload.itemId, {
+ reparentInstance(payload.itemSelector[0], {
parentId: payload.dropTarget.itemId,
position: payload.dropTarget.position,
});
diff --git a/packages/design-system/src/components/tree/horizontal-shift.test.ts b/packages/design-system/src/components/tree/horizontal-shift.test.ts
index 31ac702838..7abf498953 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.test.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.test.ts
@@ -144,7 +144,7 @@ test("drop target is empty or collapsed", () => {
const result = render({ dragItem: box1, dropTarget });
// parent doesn't change
- expect(result?.item.id).toBe(box2.id);
+ expect(result?.itemSelector).toEqual(["box2", "root"]);
// placement line geometry isn't provided
expect(result?.placement).toBeUndefined();
@@ -157,7 +157,7 @@ test("placement line coordinates are always adjusted", () => {
);
// parent doesn't change
- expect(result?.item.id).toBe(box3.id);
+ expect(result?.itemSelector).toEqual(["box3", "root"]);
// placement line is adjusted to account for depth,
// even though depth didn't change
@@ -175,11 +175,11 @@ test("shifting is relative to the drag item's depth", () => {
// box2's depth is 1, so it's inserted without shifting
const result1 = render({ dragItem: box2, dropTarget }, shift);
- expect(result1?.item.id).toBe(tree.id);
+ expect(result1?.itemSelector).toEqual(["root"]);
// box31's depth is 2, so it's inserted with shifting, to maintain the same depth
const result2 = render({ dragItem: box31, dropTarget }, shift);
- expect(result2?.item.id).toBe(box3.id);
+ expect(result2?.itemSelector).toEqual(["box3", "root"]);
expect(result2?.position).toBe("end");
});
@@ -189,7 +189,7 @@ describe("shifting to the left", () => {
{ dragItem: box1, dropTarget: makeDrop({ into: tree, after: box2 }) },
-1
);
- expect(result?.item.id).toBe(tree.id);
+ expect(result?.itemSelector).toEqual(["root"]);
});
test("a shifting is possible only when we're at the bottom of the initial drop target", () => {
@@ -197,7 +197,7 @@ describe("shifting to the left", () => {
{ dragItem: box1, dropTarget: makeDrop({ into: box3, after: box31 }) },
-1
);
- expect(result1?.item.id).toBe(box3.id);
+ expect(result1?.itemSelector).toEqual(["box3", "root"]);
});
test("when above the drag item, which is at the bottom, the shift is allowed", () => {
@@ -205,7 +205,7 @@ describe("shifting to the left", () => {
{ dragItem: box32, dropTarget: makeDrop({ into: box3, after: box31 }) },
-1
);
- expect(result?.item.id).toBe(tree.id);
+ expect(result?.itemSelector).toEqual(["root"]);
expect(result?.position).toBe(tree.children.indexOf(box3) + 1);
expect(result?.placement).toEqual({
...makePlacement(),
@@ -221,7 +221,7 @@ describe("shifting to the left", () => {
};
const result1 = render(args, 0);
- expect(result1?.item.id).toBe(tree.id);
+ expect(result1?.itemSelector).toEqual(["root"]);
expect(result1?.position).toBe(tree.children.indexOf(box3) + 1);
expect(result1?.placement).toEqual({
...makePlacement(),
@@ -230,7 +230,7 @@ describe("shifting to the left", () => {
});
const result2 = render(args, 1);
- expect(result2?.item.id).toBe(box3.id);
+ expect(result2?.itemSelector).toEqual(["box3", "root"]);
expect(result2?.position).toBe(box3.children.indexOf(box32) + 1);
expect(result2?.placement).toEqual({
...makePlacement(),
@@ -247,7 +247,7 @@ describe("shifting to the left", () => {
},
-10
);
- expect(result?.item.id).toBe(box5.id);
+ expect(result?.itemSelector).toEqual(["box5", "root"]);
expect(result?.position).toBe(box5.children.indexOf(box51) + 1);
});
});
@@ -258,7 +258,7 @@ describe("shifting to the right ", () => {
{ dragItem: box1, dropTarget: makeDrop({ into: tree, after: box2 }) },
1
);
- expect(result?.item.id).toBe(tree.id);
+ expect(result?.itemSelector).toEqual(["root"]);
});
test("if there's an expanded item above, we shift inside it", () => {
@@ -268,10 +268,10 @@ describe("shifting to the right ", () => {
};
const result1 = render(args, 1);
- expect(result1?.item.id).toBe(box3.id);
+ expect(result1?.itemSelector).toEqual(["box3", "root"]);
const result2 = render(args, 2);
- expect(result2?.item.id).toBe(box32.id);
+ expect(result2?.itemSelector).toEqual(["box32", "box3", "root"]);
});
test("you cannot move inside drag item by shifting", () => {
@@ -280,7 +280,7 @@ describe("shifting to the right ", () => {
{ dragItem: box3, dropTarget: makeDrop({ into: tree, after: box3 }) },
3
);
- expect(result1?.item.id).toBe(tree.id);
+ expect(result1?.itemSelector).toEqual(["root"]);
// drag item is inside the item above
// we shift into the item above, but not inside the drag item
@@ -288,7 +288,7 @@ describe("shifting to the right ", () => {
{ dragItem: box32, dropTarget: makeDrop({ into: tree, after: box3 }) },
3
);
- expect(result2?.item.id).toBe(box3.id);
+ expect(result2?.itemSelector).toEqual(["box3", "root"]);
expect(result2?.position).toBe("end");
});
@@ -297,7 +297,7 @@ describe("shifting to the right ", () => {
{ dragItem: box4, dropTarget: makeDrop({ into: tree, after: box4 }) },
1
);
- expect(result?.item.id).toBe(box3.id);
+ expect(result?.itemSelector).toEqual(["box3", "root"]);
expect(result?.position).toBe("end");
});
@@ -309,6 +309,6 @@ describe("shifting to the right ", () => {
},
1
);
- expect(result?.item.id).toBe(tree.id);
+ expect(result?.itemSelector).toEqual(["root"]);
});
});
diff --git a/packages/design-system/src/components/tree/horizontal-shift.ts b/packages/design-system/src/components/tree/horizontal-shift.ts
index bfe8e1648b..37624832f5 100644
--- a/packages/design-system/src/components/tree/horizontal-shift.ts
+++ b/packages/design-system/src/components/tree/horizontal-shift.ts
@@ -3,8 +3,8 @@ import type { Placement } from "../primitives/dnd";
import type { ItemDropTarget, ItemSelector } from "./item-utils";
import { getPlacementIndicatorAlignment } from "./tree-node";
-export type ShiftedDropTarget<Data> = {
- item: Data;
+export type ShiftedDropTarget = {
+ itemSelector: ItemSelector;
position: number | "end";
placement?: Placement;
};
@@ -30,7 +30,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
// Here we want to allow user to shift placement line horizontally
// but only if that corresponds to a meaningful position in the tree
- const shiftedDropTarget = useMemo<ShiftedDropTarget<Data> | undefined>(() => {
+ const shiftedDropTarget = useMemo((): ShiftedDropTarget | undefined => {
if (dropTarget === undefined || dragItemSelector === undefined) {
return undefined;
}
@@ -57,14 +57,14 @@ export const useHorizontalShift = <Data extends { id: string }>({
// In this case the placement line coordinates are meaningless in the context of the tree.
// We're dropping the placement and not performing any shifting.
if (placement.type === "inside-parent") {
- return { item: data, position: "end" };
+ return { itemSelector: dropItemSelector, position: "end" };
}
const currentDepth = dropItemSelector.length;
const desiredDepth = dragItemDepth + horizontalShift;
const withoutShift = {
- item: data,
+ itemSelector: dropItemSelector,
position: indexWithinChildren,
placement: shiftPlacement(currentDepth),
} as const;
@@ -78,6 +78,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
if (desiredDepth < currentDepth) {
let shifted = 0;
let newParent = data;
+ let newParentSelector = dropItemSelector;
let newPosition = indexWithinChildren;
const isAtTheBottom = (parent: Data, index: number) => {
@@ -99,6 +100,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
) {
shifted = index;
newParent = potentialNewParent;
+ newParentSelector = dropItemSelector.slice(index);
const child = dropTargetPath[index - 1];
const childPosition = getItemChildren(newParent).findIndex(
(item) => item.id === child.id
@@ -114,7 +116,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
}
return {
- item: newParent,
+ itemSelector: newParentSelector,
position: newPosition,
placement: shiftPlacement(currentDepth - shifted),
};
@@ -123,6 +125,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
if (desiredDepth > currentDepth) {
let shifted = 0;
let newParent = data;
+ let newParentSelector = dropItemSelector;
const findNextParent = (
parent: Data,
@@ -147,6 +150,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
shifted < desiredDepth - currentDepth
) {
newParent = potentialNewParent;
+ newParentSelector = [newParent.id, ...newParentSelector];
potentialNewParent = findNextParent(newParent, "last");
shifted++;
}
@@ -156,7 +160,7 @@ export const useHorizontalShift = <Data extends { id: string }>({
}
return {
- item: newParent,
+ itemSelector: newParentSelector,
position: "end",
placement: shiftPlacement(currentDepth + shifted),
};
diff --git a/packages/design-system/src/components/tree/test-tree-data.ts b/packages/design-system/src/components/tree/test-tree-data.ts
index 65e14d3819..3ce1a26542 100644
--- a/packages/design-system/src/components/tree/test-tree-data.ts
+++ b/packages/design-system/src/components/tree/test-tree-data.ts
@@ -1,4 +1,5 @@
import produce from "immer";
+import type { ItemSelector } from "./item-utils";
export type Item = {
id: string;
@@ -46,10 +47,10 @@ export const findItemById = (root: Item, id: string) => {
export const reparent = (
root: Item,
{
- itemId,
+ itemSelector,
dropTarget,
}: {
- itemId: string;
+ itemSelector: ItemSelector;
dropTarget: {
itemId: string;
position: number | "end";
@@ -57,6 +58,7 @@ export const reparent = (
}
) =>
produce(root, (draft) => {
+ const [itemId] = itemSelector;
const path = getItemPath(draft, itemId);
const item = path[path.length - 1];
const currentParent = path[path.length - 2];
diff --git a/packages/design-system/src/components/tree/tree.tsx b/packages/design-system/src/components/tree/tree.tsx
index 3a1d010768..c9d6430ecf 100644
--- a/packages/design-system/src/components/tree/tree.tsx
+++ b/packages/design-system/src/components/tree/tree.tsx
@@ -35,7 +35,7 @@ export type TreeProps<Data extends { id: string }> = {
onHover?: (item: Data | undefined) => void;
animate?: boolean;
onDragEnd: (event: {
- itemId: string;
+ itemSelector: ItemSelector;
dropTarget: { itemId: string; position: number | "end" };
}) => void;
};
@@ -224,9 +224,9 @@ export const Tree = <Data extends { id: string }>({
onEnd: ({ isCanceled }) => {
if (shiftedDropTarget && dragItemSelector && isCanceled === false) {
onDragEnd({
- itemId: dragItemSelector[0],
+ itemSelector: dragItemSelector,
dropTarget: {
- itemId: shiftedDropTarget.item.id,
+ itemId: shiftedDropTarget.itemSelector[0],
position: shiftedDropTarget.position,
},
});
@@ -298,7 +298,7 @@ export const Tree = <Data extends { id: string }>({
getIsExpanded={getIsExpanded}
setIsExpanded={setIsExpanded}
onExpandTransitionEnd={dropHandlers.handleDomMutation}
- dropTargetItemId={shiftedDropTarget?.item?.id}
+ dropTargetItemId={shiftedDropTarget?.itemSelector[0]}
/>
</Box>