Skip to content

fix(core): track overlay on inner-container scroll (#913) #1690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aalimovs wants to merge 2 commits into
base: main
Choose a base branch
from
+43 −40
Open

fix(core): track overlay on inner-container scroll (#913) #1690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f09359
fix(core): track overlay on inner-container scroll (#913)
aalimovs Jun 6, 2026
441cd5b
Merge branch 'main' into fix/913-overlay-scroll-tracking
aalimovs Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 43 additions & 19 deletions packages/core/components/DraggableComponent/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import { createDynamicCollisionDetector } from "../../lib/dnd/collision/dynamic"
import { DragAxis } from "../../types";
import { UniqueIdentifier } from "@dnd-kit/abstract";
import { Feedback } from "@dnd-kit/dom";
import { getDeepScrollPosition } from "../../lib/get-deep-scroll-position";
import { DropZoneContext, ZoneStoreContext } from "../DropZone/context";
import { useShallow } from "zustand/react/shallow";
import { getItem } from "../../lib/data/get-item";
Expand Down Expand Up @@ -294,24 +293,29 @@ export const DraggableComponent = ({
})();

const portalContainerRect = portalContainerEl?.getBoundingClientRect();
const portalScroll = portalContainerEl
? getDeepScrollPosition(portalContainerEl)
: { x: 0, y: 0 };
const deepScrollPosition = targetIsFixed
? { x: 0, y: 0 }
: getDeepScrollPosition(el);

// #913: The overlay is position:absolute inside the portal target, so it only
// moves with that target's own scroll — NOT with intermediate scroll containers
// (e.g. a DropZone with overflow:auto) sitting between the item and the portal
// target. The previous getDeepScrollPosition(el) summed every ancestor's scroll,
// which cancelled the item's getBoundingClientRect() movement and froze the
// overlay whenever such an inner container was scrolled.
const scroll = targetIsFixed
? { x: 0, y: 0 }
: portalContainerEl
? {
// Non-iframe: overlay is absolutely positioned inside portalContainerEl,
// so compensate for that container's own scroll only.
x: portalContainerEl.scrollLeft - (portalContainerRect?.left ?? 0),
y: portalContainerEl.scrollTop - (portalContainerRect?.top ?? 0),
}
: {
x:
deepScrollPosition.x -
portalScroll.x -
(portalContainerRect?.left ?? 0),
y:
deepScrollPosition.y -
portalScroll.y -
(portalContainerRect?.top ?? 0),
// Portal target is a document <body> — the iframe's body in iframe mode,
// or the top document's body when there's no [data-puck-preview] ancestor.
// It's positioned against the ICB, so compensate for that document's own
// scroll only.
x: el.ownerDocument.defaultView?.scrollX ?? 0,
y: el.ownerDocument.defaultView?.scrollY ?? 0,
};

const style: CSSProperties = {
Expand Down Expand Up @@ -592,9 +596,16 @@ export const DraggableComponent = ({
if (thisWasDragging) return onDragFinished();
}, [thisWasDragging, onDragFinished]);

// PERFORMANCE: when visible, respond to scroll/resize + track layout shifts without a global rAF loop
// PERFORMANCE: when visible, respond to scroll/resize; only selected/dragging
// items also run a throttled rAF loop to track layout shifts (hover does not).
useEffect(() => {
if (!dragFinished || !(isSelected || thisIsDragging)) return;
// #913: also re-sync on scroll while hovering, not only when selected/dragging,
// so a hovered component's overlay tracks inner-container scroll too.
if (
!dragFinished ||
!(isSelected || thisIsDragging || hover || indicativeHover)
)
return;

const el = ref.current;
if (!el) return;
Expand Down Expand Up @@ -639,14 +650,27 @@ export const DraggableComponent = ({
frame = requestAnimationFrame(tick);
};

frame = requestAnimationFrame(tick);
// #913 / perf: only selected or dragging items need the continuous rAF
// layout-shift tracker — they can be pushed around by content or animation
// changes. A merely-hovered item just needs the event-driven scroll/resize
// listeners above, so don't spin a per-frame loop while the mouse rests on it.
if (isSelected || thisIsDragging) {
frame = requestAnimationFrame(tick);
}

return () => {
doc.removeEventListener("scroll", onScroll, true);
view.removeEventListener("resize", onResize);
cancelAnimationFrame(frame);
};
}, [dragFinished, isSelected, thisIsDragging, scheduleSync]);
}, [
dragFinished,
isSelected,
thisIsDragging,
hover,
indicativeHover,
scheduleSync,
]);

const syncActionsPosition = useCallback(
(el: HTMLDivElement | null | undefined) => {
Expand Down
21 changes: 0 additions & 21 deletions packages/core/lib/get-deep-scroll-position.ts
View file
Open in desktop

This file was deleted.

Loading