@jekrch/react-viewport-lightbox 0.3.1 → 0.4.0

package/dist/index.d.cts

@@ -238,8 +238,12 @@ interface ImageZoomPanState {
         height: number;
     }>;
     resetTransform: () => void;
-    setTransform: (t: ImageTransform, animate?: boolean) => void;
-    applyTransform: (t: ImageTransform, animate?: boolean) => void;
+    /**
+     * `animate` may be a boolean (true = default 0.2s ease-out) or an explicit
+     * CSS transition string (e.g. a shorter one for smooth wheel-zoom stepping).
+     */
+    setTransform: (t: ImageTransform, animate?: boolean | string) => void;
+    applyTransform: (t: ImageTransform, animate?: boolean | string) => void;
     clampTranslate: (x: number, y: number, scale: number) => {
         x: number;
         y: number;
@@ -275,11 +279,18 @@ interface SlideNavigationState {
     swipeOffset: number;
     swipeOffsetRef: React.MutableRefObject<number>;
     commitLockRef: React.MutableRefObject<boolean>;
+    /**
+     * Px distance the committed slide travels; also where the neighbor panels are
+     * positioned so they land centered. See {@link measureSlideDistance}.
+     */
+    slideDistance: number;
     applySlideOffset: (offset: number, animate?: boolean) => void;
     commitSlide: (direction: "prev" | "next") => void;
     snapBack: () => void;
     resolveSlide: (gestureStartTime: number) => void;
     setSlideActive: React.Dispatch<React.SetStateAction<boolean>>;
+    /** Measure the current image and refresh {@link slideDistance} (call at drag start). */
+    refreshSlideDistance: () => void;
 }
 /**
  * Manages the three-slot slide carousel: swipe offset tracking, animated
@@ -300,6 +311,13 @@ interface GestureHandlers {
     handleTouchStart: (e: React.TouchEvent) => void;
     handleTouchMove: (e: React.TouchEvent) => void;
     handleTouchEnd: (e: React.TouchEvent) => void;
+    /**
+     * True when the most recent gesture involved real movement (a locked/rejected
+     * swipe, a pan, or a pinch) rather than a stationary tap. Consumers use this
+     * to tell a background swipe apart from a background tap so a swipe that ends
+     * over empty space doesn't get mistaken for a tap-to-close.
+     */
+    gestureMovedRef: React.MutableRefObject<boolean>;
 }
 /**
  * Coordinates zoom/pan and slide gestures, routing pointer and touch events

package/dist/index.d.ts

@@ -238,8 +238,12 @@ interface ImageZoomPanState {
         height: number;
     }>;
     resetTransform: () => void;
-    setTransform: (t: ImageTransform, animate?: boolean) => void;
-    applyTransform: (t: ImageTransform, animate?: boolean) => void;
+    /**
+     * `animate` may be a boolean (true = default 0.2s ease-out) or an explicit
+     * CSS transition string (e.g. a shorter one for smooth wheel-zoom stepping).
+     */
+    setTransform: (t: ImageTransform, animate?: boolean | string) => void;
+    applyTransform: (t: ImageTransform, animate?: boolean | string) => void;
     clampTranslate: (x: number, y: number, scale: number) => {
         x: number;
         y: number;
@@ -275,11 +279,18 @@ interface SlideNavigationState {
     swipeOffset: number;
     swipeOffsetRef: React.MutableRefObject<number>;
     commitLockRef: React.MutableRefObject<boolean>;
+    /**
+     * Px distance the committed slide travels; also where the neighbor panels are
+     * positioned so they land centered. See {@link measureSlideDistance}.
+     */
+    slideDistance: number;
     applySlideOffset: (offset: number, animate?: boolean) => void;
     commitSlide: (direction: "prev" | "next") => void;
     snapBack: () => void;
     resolveSlide: (gestureStartTime: number) => void;
     setSlideActive: React.Dispatch<React.SetStateAction<boolean>>;
+    /** Measure the current image and refresh {@link slideDistance} (call at drag start). */
+    refreshSlideDistance: () => void;
 }
 /**
  * Manages the three-slot slide carousel: swipe offset tracking, animated
@@ -300,6 +311,13 @@ interface GestureHandlers {
     handleTouchStart: (e: React.TouchEvent) => void;
     handleTouchMove: (e: React.TouchEvent) => void;
     handleTouchEnd: (e: React.TouchEvent) => void;
+    /**
+     * True when the most recent gesture involved real movement (a locked/rejected
+     * swipe, a pan, or a pinch) rather than a stationary tap. Consumers use this
+     * to tell a background swipe apart from a background tap so a swipe that ends
+     * over empty space doesn't get mistaken for a tap-to-close.
+     */
+    gestureMovedRef: React.MutableRefObject<boolean>;
 }
 /**
  * Coordinates zoom/pan and slide gestures, routing pointer and touch events