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.

Allow to reset drop target (#1541)

Bogdan Chadkinc2ac8ed35494
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/use-sortable.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/use-sortable.tsx
index 346043602a..8b5ad189f9 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/use-sortable.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/use-sortable.tsx
@@ -44,12 +44,16 @@ export const useSortable = <Item extends { id: string }>({
},
onDropTargetChange(dropTarget) {
setDropTarget(dropTarget);
- setPlacementIndicator(
- computeIndicatorPlacement({
- placement: dropTarget.placement,
- element: dropTarget.element,
- })
- );
+ if (dropTarget === undefined) {
+ setPlacementIndicator(undefined);
+ } else {
+ setPlacementIndicator(
+ computeIndicatorPlacement({
+ placement: dropTarget.placement,
+ element: dropTarget.element,
+ })
+ );
+ }
},
});
diff --git a/apps/builder/app/builder/features/style-panel/style-source/use-sortable.tsx b/apps/builder/app/builder/features/style-panel/style-source/use-sortable.tsx
index a77a7f4a7b..7186ff7542 100644
--- a/apps/builder/app/builder/features/style-panel/style-source/use-sortable.tsx
+++ b/apps/builder/app/builder/features/style-panel/style-source/use-sortable.tsx
@@ -54,13 +54,17 @@ export const useSortable = <Item extends { id: string }>({
},
onDropTargetChange(dropTarget) {
setDropTarget(dropTarget);
- setPlacementIndicator(
- computeIndicatorPlacement({
- ...sharedDropOptions,
- placement: dropTarget.placement,
- element: dropTarget.element,
- })
- );
+ if (dropTarget === undefined) {
+ setPlacementIndicator(undefined);
+ } else {
+ setPlacementIndicator(
+ computeIndicatorPlacement({
+ ...sharedDropOptions,
+ placement: dropTarget.placement,
+ element: dropTarget.element,
+ })
+ );
+ }
},
});
@@ -89,6 +93,7 @@ export const useSortable = <Item extends { id: string }>({
useDropHandlers.handleEnd({ isCanceled });
setDragItemId(undefined);
setDropTarget(undefined);
+ setPlacementIndicator(undefined);
if (isCanceled || dropTarget === undefined || dragItemId === undefined) {
return;
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
index 0e43d01f14..ecd9a36514 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
@@ -44,11 +44,13 @@ export const CanvasTools = ({ publish }: CanvasToolsProps) => {
if (
dragAndDropState.isDragging &&
- dragAndDropState.dropTarget !== undefined &&
dragAndDropState.placementIndicator !== undefined
) {
const { dropTarget, placementIndicator } = dragAndDropState;
- const dropTargetInstance = instances.get(dropTarget.itemSelector[0]);
+ const dropTargetInstance =
+ dropTarget === undefined
+ ? undefined
+ : instances.get(dropTarget.itemSelector[0]);
return dropTargetInstance ? (
<div className={containerStyle({ overflow: "hidden" })}>
<Outline rect={placementIndicator.parentRect}>
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.ts b/apps/builder/app/canvas/shared/use-drag-drop.ts
index b62cc47046..3c9d3a67c4 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.ts
+++ b/apps/builder/app/canvas/shared/use-drag-drop.ts
@@ -10,7 +10,7 @@ import {
computeIndicatorPlacement,
} from "@webstudio-is/design-system";
import { getComponentMeta } from "@webstudio-is/react-sdk";
-import { instancesStore, selectedPageStore } from "~/shared/nano-states";
+import { instancesStore } from "~/shared/nano-states";
import { textEditingInstanceSelectorStore } from "~/shared/nano-states";
import { publish, useSubscribe } from "~/shared/pubsub";
import {
@@ -33,8 +33,8 @@ declare module "~/shared/pubsub" {
dragEnd: DragEndPayload;
dragMove: DragMovePayload;
dragStart: DragStartPayload;
- dropTargetChange: ItemDropTarget;
- placementIndicatorChange: Placement;
+ dropTargetChange: undefined | ItemDropTarget;
+ placementIndicatorChange: undefined | Placement;
}
}
@@ -102,20 +102,6 @@ const sharedDropOptions = {
},
};
-const getDefaultDropTarget = () => {
- const selectedPage = selectedPageStore.get();
- if (selectedPage === undefined) {
- throw new Error("Could not find selected page");
- }
- const rootInstanceSelector = [selectedPage.rootInstanceId];
- const element = getElementByInstanceSelector(rootInstanceSelector);
- // Should never happen
- if (element === undefined) {
- throw new Error("Could not find root instance element");
- }
- return { element, data: rootInstanceSelector };
-};
-
export const useDragAndDrop = () => {
const state = useRef({ ...initialState });
@@ -137,13 +123,10 @@ export const useDragAndDrop = () => {
const { dragPayload } = state.current;
if (dropTarget === undefined || dragPayload === undefined) {
- return getDefaultDropTarget();
+ return;
}
const dropInstanceSelector = dropTarget.data;
- if (dropInstanceSelector.length === 1) {
- return dropTarget;
- }
const newDropInstanceSelector = dropInstanceSelector.slice();
if (dropTarget.area !== "center") {
@@ -164,7 +147,7 @@ export const useDragAndDrop = () => {
newDropInstanceSelector
);
if (droppableInstanceSelector === undefined) {
- return getDefaultDropTarget();
+ return;
}
if (
@@ -178,7 +161,7 @@ export const useDragAndDrop = () => {
const element = getElementByInstanceSelector(droppableInstanceSelector);
if (element === undefined) {
- return getDefaultDropTarget();
+ return;
}
return { data: droppableInstanceSelector, element };
@@ -187,11 +170,14 @@ export const useDragAndDrop = () => {
onDropTargetChange(dropTarget) {
publish({
type: "dropTargetChange",
- payload: {
- placement: dropTarget.placement,
- indexWithinChildren: dropTarget.indexWithinChildren,
- itemSelector: dropTarget.data,
- },
+ payload:
+ dropTarget === undefined
+ ? undefined
+ : {
+ placement: dropTarget.placement,
+ indexWithinChildren: dropTarget.indexWithinChildren,
+ itemSelector: dropTarget.data,
+ },
});
},
});
@@ -282,6 +268,13 @@ export const useDragAndDrop = () => {
useSubscribe("dropTargetChange", (dropTarget) => {
state.current.dropTarget = dropTarget;
+ if (dropTarget === undefined) {
+ publish({
+ type: "placementIndicatorChange",
+ payload: undefined,
+ });
+ return;
+ }
const element = getElementByInstanceSelector(dropTarget.itemSelector);
if (element === undefined) {
return;
diff --git a/packages/design-system/src/components/primitives/dnd/canvas.stories.tsx b/packages/design-system/src/components/primitives/dnd/canvas.stories.tsx
index 2bbd79a532..43a124eb80 100644
--- a/packages/design-system/src/components/primitives/dnd/canvas.stories.tsx
+++ b/packages/design-system/src/components/primitives/dnd/canvas.stories.tsx
@@ -199,13 +199,6 @@ export const Canvas = () => {
const rootRef = useRef<HTMLElement | null>(null);
- const getDefaultDropTarget = () => {
- if (rootRef.current === null) {
- throw new Error("Unexpected empty rootRef during drag");
- }
- return { data: ROOT_ID, element: rootRef.current };
- };
-
const dropHandlers = useDrop<string>({
edgeDistanceThreshold: 10,
@@ -216,15 +209,11 @@ export const Canvas = () => {
swapDropTarget(dropTarget) {
const rootElement = rootRef.current;
if (dropTarget === undefined || rootElement === null) {
- return getDefaultDropTarget();
+ return;
}
const { data: id, area } = dropTarget;
- if (id === ROOT_ID) {
- return dropTarget;
- }
-
const path = findItemPath(data, id) ?? [];
if (area !== "center") {
@@ -240,13 +229,13 @@ export const Canvas = () => {
const newItem = path.find((item) => item.acceptsChildren);
if (newItem === undefined) {
- return getDefaultDropTarget();
+ return;
}
const element = idToElement(rootElement, newItem.id);
if (element === undefined) {
- return getDefaultDropTarget();
+ return;
}
return { data: newItem.id, element };
@@ -254,12 +243,16 @@ export const Canvas = () => {
onDropTargetChange(dropTarget) {
setCurrentDropTarget(dropTarget);
- setPlacementIndicator(
- computeIndicatorPlacement({
- placement: dropTarget.placement,
- element: dropTarget.element,
- })
- );
+ if (dropTarget === undefined) {
+ setPlacementIndicator(undefined);
+ } else {
+ setPlacementIndicator(
+ computeIndicatorPlacement({
+ placement: dropTarget.placement,
+ element: dropTarget.element,
+ })
+ );
+ }
},
});
diff --git a/packages/design-system/src/components/primitives/dnd/sortable-list.stories.tsx b/packages/design-system/src/components/primitives/dnd/sortable-list.stories.tsx
index ef6410b2cc..cc93ca6ef6 100644
--- a/packages/design-system/src/components/primitives/dnd/sortable-list.stories.tsx
+++ b/packages/design-system/src/components/primitives/dnd/sortable-list.stories.tsx
@@ -94,12 +94,16 @@ export const SortableList = ({
},
onDropTargetChange(dropTarget) {
setDropTarget(dropTarget);
- setPlacementIndicator(
- computeIndicatorPlacement({
- placement: dropTarget.placement,
- element: dropTarget.element,
- })
- );
+ if (dropTarget === undefined) {
+ setPlacementIndicator(undefined);
+ } else {
+ setPlacementIndicator(
+ computeIndicatorPlacement({
+ placement: dropTarget.placement,
+ element: dropTarget.element,
+ })
+ );
+ }
},
});
diff --git a/packages/design-system/src/components/primitives/dnd/use-drop.ts b/packages/design-system/src/components/primitives/dnd/use-drop.ts
index 3639a736fd..c66085fdb4 100644
--- a/packages/design-system/src/components/primitives/dnd/use-drop.ts
+++ b/packages/design-system/src/components/primitives/dnd/use-drop.ts
@@ -50,39 +50,25 @@ type UseDropProps<Data> = {
swapDropTarget: (
// undefined is passed when no suitable element is found under the pointer
dropTarget: (PartialDropTarget<Data> & { area: Area }) | undefined
- ) => PartialDropTarget<Data> & {
- // Set "final" to true if you don't want to swap any further.
- // (Normally swapDropTarget is called repeatedly until the output is the same as the input)
- final?: boolean;
- };
+ ) =>
+ | undefined
+ | (PartialDropTarget<Data> & {
+ // Set "final" to true if you don't want to swap any further.
+ // (Normally swapDropTarget is called repeatedly until the output is the same as the input)
+ final?: boolean;
+ });
- onDropTargetChange: (dropTarget: DropTarget<Data>) => void;
+ onDropTargetChange: (dropTarget: undefined | DropTarget<Data>) => void;
// Allows you to customize children
// that will be used to determine placement and indexWithinChildren
getValidChildren?: (parent: Element) => Element[] | HTMLCollection;
- // If set to true, the target selection will work as if
- // the pointer is always inside the root element's bounds.
- //
- // For example:
- // ___________
- // | |
- // | *| * - real pointer
- // | ^------- emulated pointer
- // | |
- // |___________|
- emulatePointerAlwaysInRootBounds?: boolean;
-
// If not provided, will be guessed automatically based
// on the actual orientation of the children
childrenOrientation?: ChildrenOrientation;
};
-// When emulatePointerAlwaysInRootBounds=true,
-// the pointer always will be at least 2px away from any edge of the root.
-const PADDING_WHEN_EMULATING_POINTER_IN_BOUNDS = 2;
-
type UseDropHandlers = {
handleMove: (pointerCoordinates: Point) => void;
handleScroll: () => void;
@@ -143,7 +129,15 @@ export const useDrop = <Data>(props: UseDropProps<Data>): UseDropHandlers => {
return result;
};
- const setDropTarget = (partialDropTarget: PartialDropTarget<Data>) => {
+ const setDropTarget = (
+ partialDropTarget: undefined | PartialDropTarget<Data>
+ ) => {
+ if (partialDropTarget === undefined) {
+ state.current.dropTarget = undefined;
+ latestProps.current.onDropTargetChange(undefined);
+ return;
+ }
+
const { pointerCoordinates } = state.current;
if (pointerCoordinates === undefined) {
return;
@@ -266,8 +260,12 @@ export const useDrop = <Data>(props: UseDropProps<Data>): UseDropHandlers => {
}
let continueSwapping = true;
- while (continueSwapping || candidate == null) {
+ while (continueSwapping || candidate === undefined) {
const swappedTo = swapDropTarget(candidate);
+ if (swappedTo === undefined) {
+ candidate = undefined;
+ break;
+ }
continueSwapping =
swappedTo.element !== candidate?.element && swappedTo.final !== true;
candidate = withArea(swappedTo);
@@ -278,25 +276,7 @@ export const useDrop = <Data>(props: UseDropProps<Data>): UseDropHandlers => {
return {
handleMove(pointerCoordinates) {
- if (latestProps.current.emulatePointerAlwaysInRootBounds === true) {
- const rect = (rootRef.current as Element).getBoundingClientRect();
- const { x, y } = pointerCoordinates;
- state.current.pointerCoordinates = {
- x: Math.max(
- rect.left + PADDING_WHEN_EMULATING_POINTER_IN_BOUNDS,
- Math.min(rect.right - PADDING_WHEN_EMULATING_POINTER_IN_BOUNDS, x)
- ),
- y: Math.max(
- rect.top + PADDING_WHEN_EMULATING_POINTER_IN_BOUNDS,
- Math.min(
- rect.bottom - PADDING_WHEN_EMULATING_POINTER_IN_BOUNDS,
- y
- )
- ),
- };
- } else {
- state.current.pointerCoordinates = pointerCoordinates;
- }
+ state.current.pointerCoordinates = pointerCoordinates;
detectTarget();
},
diff --git a/packages/design-system/src/components/tree/tree.tsx b/packages/design-system/src/components/tree/tree.tsx
index d49168b32d..d4ab756a9a 100644
--- a/packages/design-system/src/components/tree/tree.tsx
+++ b/packages/design-system/src/components/tree/tree.tsx
@@ -38,7 +38,7 @@ export type TreeProps<Data extends { id: string }> = {
onSelect?: (itemSelector: ItemSelector) => void;
onHover?: (itemSelector: undefined | ItemSelector) => void;
animate?: boolean;
- onDropTargetChange: (dropTarget: ItemDropTarget) => void;
+ onDropTargetChange: (dropTarget: undefined | ItemDropTarget) => void;
onDragItemChange: (itemSelector: ItemSelector) => void;
onDragEnd: (event: {
itemSelector: ItemSelector;
@@ -102,12 +102,6 @@ export const Tree = <Data extends { id: string }>({
});
}, [dropTarget]);
- const getDropTargetElement = useCallback(
- (id: string): HTMLElement | null | undefined =>
- rootRef.current?.querySelector(`[data-drop-target-id="${id}"]`),
- []
- );
-
const [shiftedDropTarget, setHorizontalShift] = useHorizontalShift({
dragItemSelector,
dropTarget,
@@ -118,14 +112,6 @@ export const Tree = <Data extends { id: string }>({
canAcceptChild,
});
- const getFallbackDropTarget = () => {
- return {
- data: [root.id],
- element: getDropTargetElement(root.id) as HTMLElement,
- final: true,
- };
- };
-
const useHoldHandler = useHold({
data: dropTarget,
isEqual: (a, b) => areItemSelectorsEqual(a?.itemSelector, b?.itemSelector),
@@ -143,8 +129,6 @@ export const Tree = <Data extends { id: string }>({
const dropHandlers = useDrop<ItemSelector>({
...sharedDropOptions,
- emulatePointerAlwaysInRootBounds: true,
-
elementToData: (element) => {
// We want to make sure edge detection is calculated relative
// to the element with the data-drop-target-id attribute.
@@ -158,12 +142,7 @@ export const Tree = <Data extends { id: string }>({
swapDropTarget: (dropTarget) => {
if (dragItemSelector === undefined || dropTarget === undefined) {
- return getFallbackDropTarget();
- }
-
- // drop target is the root
- if (dropTarget.data.length === 1) {
- return dropTarget;
+ return;
}
let newDropItemSelector = dropTarget.data.slice();
@@ -184,7 +163,7 @@ export const Tree = <Data extends { id: string }>({
canAcceptChild(itemId)
);
if (ancestorIndex === -1) {
- return getFallbackDropTarget();
+ return;
}
newDropItemSelector = newDropItemSelector.slice(ancestorIndex);
@@ -194,19 +173,23 @@ export const Tree = <Data extends { id: string }>({
);
if (element === undefined) {
- return getFallbackDropTarget();
+ return;
}
return { data: newDropItemSelector, element, final: true };
},
onDropTargetChange: (dropTarget) => {
- const itemDropTarget = {
- itemSelector: dropTarget.data,
- indexWithinChildren: dropTarget.indexWithinChildren,
- placement: dropTarget.placement,
- };
- onDropTargetChange(itemDropTarget);
+ if (dropTarget === undefined) {
+ onDropTargetChange(undefined);
+ } else {
+ const itemDropTarget = {
+ itemSelector: dropTarget.data,
+ indexWithinChildren: dropTarget.indexWithinChildren,
+ placement: dropTarget.placement,
+ };
+ onDropTargetChange(itemDropTarget);
+ }
},
});