@humanspeak/svelte-motion 0.4.4 → 0.4.5

package/dist/components/layoutScroll.context.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Deferred references to the chain of `layoutScroll` ancestors for the
+ * current subtree. Returned as a thunk because element refs are bound
+ * after mount; consumers invoke at measurement time.
+ *
+ * Order is closest-first. Order doesn't matter for the current scroll-
+ * offset sum, but is preserved so future per-container semantics (e.g.
+ * a `scroll.wasRoot` marker like framer-motion) can iterate deterministically.
+ */
+export type LayoutScrollContainerRef = () => Array<HTMLElement | null | undefined>;
+/**
+ * Publish the scroll-container chain for descendant motion components.
+ *
+ * Called on a `motion.*` component with `layoutScroll` enabled during
+ * its init phase. The provided thunk should resolve to `[...ancestorChain,
+ * ownElement]` — descendants get the full chain in one call.
+ *
+ * Mirrors framer-motion's `removeElementScroll`, which walks the path
+ * and sums every `layoutScroll` ancestor's offset.
+ *
+ * @param ref Thunk returning the full ancestor chain (closest first).
+ */
+export declare const setLayoutScrollContainer: (ref: LayoutScrollContainerRef) => void;
+/**
+ * Capture the ancestor chain thunk at component init.
+ *
+ * Important: call this **before** the same component calls
+ * `setLayoutScrollContainer(...)`. Otherwise the lookup returns the
+ * component's own thunk (Svelte `setContext` shadows from the call site
+ * down) and the chain collapses.
+ *
+ * Returns `undefined` when no ancestor has `layoutScroll`.
+ *
+ * @returns Ancestor chain thunk, or `undefined`.
+ */
+export declare const getLayoutScrollContainerRef: () => LayoutScrollContainerRef | undefined;

package/dist/components/layoutScroll.context.js

@@ -0,0 +1,32 @@
+import { getContext, setContext } from 'svelte';
+const LAYOUT_SCROLL_CONTEXT_KEY = Symbol('layout-scroll-container');
+/**
+ * Publish the scroll-container chain for descendant motion components.
+ *
+ * Called on a `motion.*` component with `layoutScroll` enabled during
+ * its init phase. The provided thunk should resolve to `[...ancestorChain,
+ * ownElement]` — descendants get the full chain in one call.
+ *
+ * Mirrors framer-motion's `removeElementScroll`, which walks the path
+ * and sums every `layoutScroll` ancestor's offset.
+ *
+ * @param ref Thunk returning the full ancestor chain (closest first).
+ */
+export const setLayoutScrollContainer = (ref) => {
+    setContext(LAYOUT_SCROLL_CONTEXT_KEY, ref);
+};
+/**
+ * Capture the ancestor chain thunk at component init.
+ *
+ * Important: call this **before** the same component calls
+ * `setLayoutScrollContainer(...)`. Otherwise the lookup returns the
+ * component's own thunk (Svelte `setContext` shadows from the call site
+ * down) and the chain collapses.
+ *
+ * Returns `undefined` when no ancestor has `layoutScroll`.
+ *
+ * @returns Ancestor chain thunk, or `undefined`.
+ */
+export const getLayoutScrollContainerRef = () => {
+    return getContext(LAYOUT_SCROLL_CONTEXT_KEY);
+};

package/dist/html/_MotionContainer.svelte

@@ -65,6 +65,10 @@
         SVG_NAMESPACE
     } from '../utils/svg'
     import { getLayoutIdRegistry } from '../utils/layoutId'
+    import {
+        getLayoutScrollContainerRef,
+        setLayoutScrollContainer
+    } from '../components/layoutScroll.context'
 
     type Props = MotionProps & {
         children?: Snippet
@@ -118,6 +122,7 @@
         dragControls: dragControlsProp,
         layout: layoutProp,
         layoutId: layoutIdProp,
+        layoutScroll: layoutScrollProp,
         ref: element = $bindable(null),
         ...rest
     }: Props = $props()
@@ -142,6 +147,30 @@
     // Get layoutId registry (provided by AnimatePresence or a parent LayoutGroup)
     const layoutIdRegistry = getLayoutIdRegistry()
 
+    // Capture the ancestor `layoutScroll` chain BEFORE we potentially shadow
+    // the context with ourselves below — this element's own FLIP measurements
+    // must resolve against the *ancestors*' scroll containers, not against
+    // itself.
+    //
+    // We walk the full chain (not just the nearest) so a `layoutScroll`
+    // outside another `layoutScroll` still contributes to descendant
+    // measurements — matches framer-motion's `removeElementScroll` walking
+    // `this.path`.
+    const ancestorScrollContainerRef = getLayoutScrollContainerRef()
+    if (layoutScrollProp) {
+        // Publish [...ancestorChain, ownElement]. The chain is collected
+        // lazily because element refs bind after mount.
+        setLayoutScrollContainer(() => {
+            const inherited = ancestorScrollContainerRef?.() ?? []
+            return element ? [...inherited, element] : inherited
+        })
+    }
+    const resolveLayoutScrollAncestors = (): HTMLElement[] => {
+        const refs = ancestorScrollContainerRef?.() ?? []
+        // Filter out unbound refs (HTMLElement | null | undefined → HTMLElement[]).
+        return refs.filter((el): el is HTMLElement => Boolean(el))
+    }
+
     // Get current presence depth (0 = direct child of AnimatePresence, undefined = not in AnimatePresence)
     const presenceDepth = getPresenceDepth()
 
@@ -213,11 +242,14 @@
     $effect(() => {
         if (!(element && layoutIdProp && layoutIdRegistry)) return
 
-        // Capture rect on every frame while mounted
+        // Capture rect on every frame while mounted. Re-express in the
+        // nearest layoutScroll ancestor's coordinate space so the FLIP-from
+        // rect stored at unmount stays correct even if the scroll container
+        // moved between the snapshot and the next element's mount.
         let rafId: number
         const captureRect = () => {
             if (element) {
-                layoutIdLastRect = element.getBoundingClientRect()
+                layoutIdLastRect = measureRect(element, resolveLayoutScrollAncestors())
             }
             rafId = requestAnimationFrame(captureRect)
         }
@@ -701,17 +733,18 @@
         if (!(element && layoutProp && isLoaded === 'ready')) return
 
         // Initialize last rect on first ready frame
-        lastRect = measureRect(element!)
+        lastRect = measureRect(element!, resolveLayoutScrollAncestors())
         // Hint compositor for smoother FLIP transforms
         setCompositorHints(element!, true)
 
         let rafId: number | null = null
         const runFlip = () => {
+            const scrollContainers = resolveLayoutScrollAncestors()
             if (!lastRect) {
-                lastRect = measureRect(element!)
+                lastRect = measureRect(element!, scrollContainers)
                 return
             }
-            const next = measureRect(element!)
+            const next = measureRect(element!, scrollContainers)
             const transforms = computeFlipTransforms(lastRect, next, layoutProp ?? false)
             runFlipAnimation(element!, transforms, (mergedTransition ?? {}) as AnimationOptions)
             lastRect = next
@@ -745,7 +778,7 @@
         const prev = layoutIdRegistry.consume(layoutIdProp)
         if (!prev) return // First appearance, no animation needed
 
-        const next = measureRect(element)
+        const next = measureRect(element, resolveLayoutScrollAncestors())
         const transforms = computeFlipTransforms(prev.rect, next, true)
 
         setCompositorHints(element, true)

package/dist/types.d.ts

@@ -335,6 +335,22 @@ export type MotionProps = {
     layout?: boolean | 'position';
     /** Shared layout animation identifier. Elements with matching layoutId animate between positions. */
     layoutId?: string;
+    /**
+     * Mark this element as a scroll container so descendant `layout` animations
+     * measure rects in this container's coordinate space. Without it, scrolling
+     * mid-animation makes the FLIP transform fight the scroll and the layout
+     * animation drifts.
+     *
+     * Apply on the same element as `overflow: scroll` / `overflow: auto`.
+     *
+     * @example
+     * ```svelte
+     * <motion.div layoutScroll style="overflow: auto">
+     *   <motion.div layout />
+     * </motion.div>
+     * ```
+     */
+    layoutScroll?: boolean;
     /** Ref to the element */
     ref?: HTMLElement | null;
     /** Enable drag gestures. true for both axes, or lock to 'x'/'y'. */

package/dist/utils/layout.d.ts

@@ -5,10 +5,32 @@ import { type AnimationOptions } from 'motion';
  * Temporarily clears `transform` to avoid skewing measurements, restoring it
  * immediately after reading the rect.
  *
+ * When `scrollContainers` are provided, the returned rect is shifted by the
+ * **sum** of each container's `scrollLeft` / `scrollTop`. FLIP deltas
+ * computed from two such measures stay correct even when the user scrolls
+ * any of the containers between measurements — including a nested
+ * `layoutScroll` inside another `layoutScroll`. Mirrors framer-motion's
+ * `removeElementScroll`, which walks every ancestor in the path.
+ *
+ * Pass an empty array (or omit) for viewport-relative behaviour.
+ *
  * @param el Element to measure.
- * @return DOMRect snapshot of the element.
+ * @param scrollContainers Optional ancestor chain with `layoutScroll` enabled.
+ * @returns DOMRect snapshot of the element.
+ *
+ * @example
+ * ```ts
+ * // No scroll containers — viewport-relative rect.
+ * const rect = measureRect(node)
+ *
+ * // Single ancestor scroll container (one `layoutScroll`).
+ * const rect = measureRect(node, [scrollPanel])
+ *
+ * // Nested `layoutScroll` ancestors — sums offsets from every container.
+ * const rect = measureRect(node, [innerScroll, outerScroll])
+ * ```
  */
-export declare const measureRect: (el: HTMLElement) => DOMRect;
+export declare const measureRect: (el: HTMLElement, scrollContainers?: HTMLElement[]) => DOMRect;
 /**
  * Compute FLIP transform deltas between two rects.
  *

package/dist/utils/layout.js

@@ -5,14 +5,49 @@ import { animate } from 'motion';
  * Temporarily clears `transform` to avoid skewing measurements, restoring it
  * immediately after reading the rect.
  *
+ * When `scrollContainers` are provided, the returned rect is shifted by the
+ * **sum** of each container's `scrollLeft` / `scrollTop`. FLIP deltas
+ * computed from two such measures stay correct even when the user scrolls
+ * any of the containers between measurements — including a nested
+ * `layoutScroll` inside another `layoutScroll`. Mirrors framer-motion's
+ * `removeElementScroll`, which walks every ancestor in the path.
+ *
+ * Pass an empty array (or omit) for viewport-relative behaviour.
+ *
  * @param el Element to measure.
- * @return DOMRect snapshot of the element.
+ * @param scrollContainers Optional ancestor chain with `layoutScroll` enabled.
+ * @returns DOMRect snapshot of the element.
+ *
+ * @example
+ * ```ts
+ * // No scroll containers — viewport-relative rect.
+ * const rect = measureRect(node)
+ *
+ * // Single ancestor scroll container (one `layoutScroll`).
+ * const rect = measureRect(node, [scrollPanel])
+ *
+ * // Nested `layoutScroll` ancestors — sums offsets from every container.
+ * const rect = measureRect(node, [innerScroll, outerScroll])
+ * ```
  */
-export const measureRect = (el) => {
+export const measureRect = (el, scrollContainers) => {
     const prev = el.style.transform;
     try {
         el.style.transform = 'none';
-        return el.getBoundingClientRect();
+        const rect = el.getBoundingClientRect();
+        if (!scrollContainers || scrollContainers.length === 0)
+            return rect;
+        // Re-express the rect in the *combined* scroll-container coordinate
+        // space so a subsequent scroll on any of them doesn't show up as
+        // movement. DOMRect's left/top are read-only, so allocate a fresh
+        // one with the summed offsets applied.
+        let offsetLeft = 0;
+        let offsetTop = 0;
+        for (const container of scrollContainers) {
+            offsetLeft += container.scrollLeft;
+            offsetTop += container.scrollTop;
+        }
+        return new DOMRect(rect.left + offsetLeft, rect.top + offsetTop, rect.width, rect.height);
     }
     finally {
         el.style.transform = prev;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@humanspeak/svelte-motion",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "description": "Framer Motion for Svelte 5. Declarative motion.<tag> components with AnimatePresence exit animations, gestures (hover, tap, drag, focus, in-view), variants, FLIP layout animations, shared-layout transitions, spring physics, and scroll-linked motion values. The drop-in Framer Motion alternative for Svelte and SvelteKit.",
   "keywords": [
     "svelte",