@graphcommerce/framer-scroller 6.2.0-canary.62 → 6.2.0-canary.64

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 6.2.0-canary.64
+
+### Patch Changes
+
+- [#1998](https://github.com/graphcommerce-org/graphcommerce/pull/1998) [`a788baaeb`](https://github.com/graphcommerce-org/graphcommerce/commit/a788baaeb9646c5a30b55998697d38a6093b6c44) - Added option to useScrollTo to allow/disallow stopping the scroll animation on user scroll interaction ([@bramvanderholst](https://github.com/bramvanderholst))
+
+## 6.2.0-canary.63
+
 ## 6.2.0-canary.62
 
 ## 6.2.0-canary.61

package/components/ScrollerProvider.tsx

@@ -1,5 +1,5 @@
 import { useConstant, useElementScroll } from '@graphcommerce/framer-utils'
-import { MotionValue, motionValue, Point, useMotionValue } from 'framer-motion'
+import { MotionValue, motionValue, Point, useDomEvent, useMotionValue } from 'framer-motion'
 import { PlaybackControls } from 'popmotion'
 import React, { useEffect, useRef, useMemo, useCallback } from 'react'
 import { scrollerContext } from '../context/scrollerContext'
@@ -85,6 +85,7 @@ export function ScrollerProvider(props: ScrollerProviderProps) {
   )
 
   const snap = useMotionValue(_inititalSnap)
+  const stopOnInteraction = useMotionValue(_inititalSnap)
 
   // Monitor the visbility of all elements and store them for later use.
   const items = useMotionValue<ItemState[]>([])
@@ -104,16 +105,23 @@ export function ScrollerProvider(props: ScrollerProviderProps) {
     [stop],
   )
 
-  const disableSnap = useCallback(() => {
-    if (snap.get() === false) stop()
-    if (scrollerRef.current) scrollerRef.current.style.scrollSnapType = 'none'
+  const disableSnap = useCallback(
+    (stopAnimationOnScroll = true) => {
+      stopOnInteraction.set(stopAnimationOnScroll)
+      if (snap.get() === false) stop()
+      if (scrollerRef.current) scrollerRef.current.style.scrollSnapType = 'none'
 
-    scroll.animating.set(true)
-    snap.set(false)
-  }, [snap, stop, scroll.animating])
+      scroll.animating.set(true)
+      snap.set(false)
+    },
+    [stopOnInteraction, snap, stop, scroll.animating],
+  )
 
   const enableSnap = useCallback(() => {
     if (snap.get() === true) return
+
+    stop()
+
     const scroller = scrollerRef.current
     if (scroller) scroller.style.scrollSnapType = ''
 
@@ -132,7 +140,20 @@ export function ScrollerProvider(props: ScrollerProviderProps) {
         })
       })
     }
-  }, [snap, scroll])
+  }, [snap, scroll.animating, stop])
+
+  /**
+   * If the scroller is animating and the user now uses their scrollwheel, enable the snapping
+   * behavior.
+   *
+   * If the scroller doesn't have snap enabled and isPanning===false, enable snap
+   */
+  useDomEvent(scrollerRef as React.RefObject<EventTarget>, 'wheel', () => {
+    if (stopOnInteraction.get()) enableSnap()
+  })
+  useDomEvent(scrollerRef as React.RefObject<EventTarget>, 'touchmove', () => {
+    if (stopOnInteraction.get()) stop()
+  })
 
   useObserveItems(scrollerRef, items)
 

package/hooks/useScrollTo.ts

@@ -4,6 +4,10 @@ import { useCallback, useContext } from 'react'
 import { distanceAnimationDuration } from '../utils/distanceAnimationDuration'
 import { useScrollerContext } from './useScrollerContext'
 
+type Options = {
+  stopAnimationOnScroll?: boolean
+}
+
 export function useScrollTo() {
   const { scrollerRef, register, disableSnap, enableSnap, scroll, getScrollSnapPositions } =
     useScrollerContext()
@@ -11,8 +15,13 @@ export function useScrollTo() {
   const duration = (useContext(MotionConfigContext).transition as Tween | undefined)?.duration ?? 0
 
   const scrollTo = useCallback(
-    async (incoming: Point | [number, number], retrigger = 0) => {
+    async (
+      incoming: Point | [number, number],
+      options: Options = { stopAnimationOnScroll: true },
+      __retrigger = 0,
+    ) => {
       const ref = scrollerRef.current
+      const { stopAnimationOnScroll } = options
       if (!ref) return
 
       let to: Point
@@ -24,20 +33,20 @@ export function useScrollTo() {
         to = incoming
       }
 
-      if (process.env.NODE_ENV === 'development' && scroll.animating.get() && retrigger === 0) {
+      if (process.env.NODE_ENV === 'development' && scroll.animating.get() && __retrigger === 0) {
         console.warn(
           `scrollTo triggered while another animation is in progress. This cancels the current animation and creates a new one.`,
         )
       }
 
-      if (process.env.NODE_ENV === 'development' && retrigger > 5) {
+      if (process.env.NODE_ENV === 'development' && __retrigger > 5) {
         console.error(
           `scrollTo triggered more than 5 times, is the element resizing constantly? Bailing out.`,
         )
         return
       }
 
-      if (process.env.NODE_ENV === 'development' && retrigger > 0) {
+      if (process.env.NODE_ENV === 'development' && __retrigger > 0) {
         console.warn(
           `scrollTo re-animating to because the final location changed during animation.`,
         )
@@ -47,7 +56,8 @@ export function useScrollTo() {
 
       const xDone = new Promise<void>((onComplete) => {
         if (ref.scrollLeft !== to.x) {
-          disableSnap()
+          disableSnap(stopAnimationOnScroll)
+          if (!stopAnimationOnScroll) ref.style.overflow = 'hidden'
 
           stop.push(
             animate({
@@ -68,7 +78,9 @@ export function useScrollTo() {
 
       const yDone = new Promise<void>((onComplete) => {
         if (ref.scrollTop !== to.y) {
-          disableSnap()
+          disableSnap(stopAnimationOnScroll)
+          if (!stopAnimationOnScroll) ref.style.overflow = 'hidden'
+
           stop.push(
             animate({
               from: ref.scrollTop,
@@ -92,10 +104,12 @@ export function useScrollTo() {
       register({ stop: () => stop.forEach((s) => s.stop()) })
       await Promise.all([xDone, yDone])
 
+      if (!stopAnimationOnScroll) ref.style.removeProperty('overflow')
+
       if (Array.isArray(incoming)) {
         const checkPositions = getScrollSnapPositions()
         if (checkPositions.x[incoming[0]] !== to.x || checkPositions.y[incoming[1]] !== to.y)
-          await scrollTo(incoming, retrigger + 1)
+          await scrollTo(incoming, options, __retrigger + 1)
       }
       enableSnap()
     },

package/hooks/useScroller.ts

@@ -7,7 +7,6 @@ import {
   MotionValue,
   PanHandlers,
   PanInfo,
-  useDomEvent,
   useTransform,
 } from 'framer-motion'
 import React, { ReactHTML, useEffect, useState } from 'react'
@@ -47,7 +46,7 @@ export function useScroller<
 >(props: ScrollableProps<TagName>, forwardedRef: React.ForwardedRef<E>) {
   const { hideScrollbar = false, children, grid = false, ...divProps } = props
 
-  const { scrollSnap, scrollerRef, enableSnap, disableSnap, snap, registerChildren, scroll } =
+  const { scrollSnap, scrollerRef, disableSnap, snap, registerChildren, scroll } =
     useScrollerContext()
 
   useEffect(() => {
@@ -68,19 +67,6 @@ export function useScroller<
 
   const [isPanning, setPanning] = useState(false)
 
-  /** If the scroller doesn't have snap enabled and the user is not panning, enable snap */
-  useDomEvent(scrollerRef as React.RefObject<EventTarget>, 'wheel', (e) => {
-    /**
-     * Todo: this is actually incorrect because when enabling the snap points, the area jumps to the
-     * nearest point a snap.
-     *
-     * What we SHOULD do is wait for the scroll position to be set exactly on a snappoint and then
-     * enable it. However, to do that then we need to know the position of all elements at all time,
-     * we now are lazy :)
-     */
-    if (!snap.get() && !isPanning && e instanceof WheelEvent) enableSnap()
-  })
-
   const scrollStart = useConstant(() => ({ x: motionValue(0), y: motionValue(0) }))
   const onPanStart: PanHandlers['onPanStart'] = (event) => {
     // If we're not dealing with the mouse we don't need to do anything

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/framer-scroller",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "6.2.0-canary.62",
+  "version": "6.2.0-canary.64",
   "sideEffects": false,
   "scripts": {
     "dev": "tsc -W"
@@ -16,13 +16,13 @@
   },
   "dependencies": {
     "popmotion": "11.0.5",
-    "@graphcommerce/framer-utils": "6.2.0-canary.62",
-    "@graphcommerce/image": "6.2.0-canary.62"
+    "@graphcommerce/framer-utils": "6.2.0-canary.64",
+    "@graphcommerce/image": "6.2.0-canary.64"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "6.2.0-canary.62",
-    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.62",
-    "@graphcommerce/typescript-config-pwa": "6.2.0-canary.62"
+    "@graphcommerce/eslint-config-pwa": "6.2.0-canary.64",
+    "@graphcommerce/prettier-config-pwa": "6.2.0-canary.64",
+    "@graphcommerce/typescript-config-pwa": "6.2.0-canary.64"
   },
   "peerDependencies": {
     "@mui/material": "^5.10.16",

package/types.ts

@@ -32,7 +32,7 @@ export type ScrollerContext = {
   /** @private */
   enableSnap: () => void
   /** @private */
-  disableSnap: () => void
+  disableSnap: (stopAnimationOnScroll?: boolean) => void
   /** @private */
   register: (controls: PlaybackControls) => void
   /** @private */