svg-scroll-draw 2.14.0 → 2.15.1

package/dist/horizontal/index.d.ts

@@ -1,108 +0,0 @@
-type EasingName = 'linear' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'spring' | 'bounce' | 'elastic';
-interface TriggerConfig {
-    start?: string;
-    end?: string;
-}
-interface ScrollDrawInstance {
-    destroy: () => void;
-    /** Reset and replay the animation from the beginning. */
-    replay: () => void;
-    /** Pause the animation at the current progress. */
-    pause: () => void;
-    /** Resume a paused animation. */
-    resume: () => void;
-    /** Jump to a specific progress value (0–1) and pause. */
-    seek: (progress: number) => void;
-    /** Returns current draw progress (0–1). */
-    getProgress: () => number;
-    /**
-     * Re-measure after a layout change: path lengths, and the scroll trigger window.
-     *
-     * The engine already re-measures on `resize`, on `orientationchange`, and via a
-     * `ResizeObserver` on the document element — but none of those fire for a layout
-     * change that leaves the document height alone, such as a tab switching, a
-     * sibling collapsing, or a font swapping inside a fixed-height box. Call this
-     * after one of those.
-     *
-     * Optional on this shared type because several instances here are fan-outs over
-     * other instances or SSR no-op stubs. `scrollDraw`, `scrollPin`,
-     * `scrollHorizontal`, `scrollDrawTimeline` and the group APIs all provide it;
-     * use `instance.refresh?.()` if you hold an instance of unknown origin.
-     */
-    refresh?: () => void;
-}
-
-interface ScrollHorizontalOptions {
-    /**
-     * Total horizontal travel distance in pixels.
-     *
-     * Default: `track.scrollWidth` minus the width it is seen through — the
-     * viewport, or the `scrollContainer`'s client width when one is given.
-     */
-    distance?: number;
-    /**
-     * Trigger window for the scroll → horizontal mapping.
-     * Default: `{ start: 'top top', end: 'bottom bottom' }` — full container height.
-     */
-    trigger?: TriggerConfig;
-    /** Easing for the horizontal movement. Default: `'linear'` (scrub feel). */
-    easing?: EasingName | ((t: number) => number);
-    /** Custom scroll container. Default: window. */
-    scrollContainer?: string | Element;
-    /**
-     * Element whose height defines the scroll window for the scrub.
-     *
-     * Default: the container of the track's nearest `position: sticky` ancestor —
-     * the `.outer` element in the CSS setup below, which is where the scroll room
-     * actually lives. Falls back to the track itself when there is no sticky
-     * ancestor.
-     *
-     * Why this is not the track: a sticky stage pins the track at exactly one
-     * viewport tall, so measuring `top top` → `bottom bottom` against it gives
-     * tStart === tEnd — a zero-length window, and a track that never moves.
-     */
-    triggerElement?: string | Element;
-    /**
-     * Honour `prefers-reduced-motion: reduce` by holding the track at its final
-     * position instead of scrubbing. Default: **`false`** — unlike every other
-     * API here, which defaults to `true`.
-     *
-     * The reasoning: this transform is scroll-linked scrubbing, not autonomous
-     * motion. It advances only as the user scrolls, 1:1 with their input, so it is
-     * direct manipulation rather than something that plays at them. And the
-     * alternative is worse than the motion — the panels are only reachable *via*
-     * the transform, inside a sticky `overflow: hidden` container, so applying a
-     * final state (or none at all) silently hides all of the content except one
-     * panel from exactly the users who asked for less motion.
-     *
-     * Set to `true` if your layout has an accessible non-transform fallback and you
-     * would rather drop the movement.
-     */
-    respectReducedMotion?: boolean;
-    onProgress?: (progress: number) => void;
-}
-interface ScrollHorizontalInstance extends ScrollDrawInstance {
-    /** Recalculate travel distance after layout change. */
-    refresh: () => void;
-}
-/**
- * Drive horizontal movement (translateX) from vertical scroll.
- *
- * The Apple / Stripe "scroll to reveal horizontal sections" pattern.
- * You handle the sticky + overflow CSS; `scrollHorizontal` drives the translateX.
- *
- * Minimal CSS setup:
- *   .outer  { height: 400vh; }
- *   .sticky { position: sticky; top: 0; height: 100vh; overflow: hidden; }
- *   .track  { display: flex; width: max-content; }
- *
- * @example
- * scrollHorizontal('.track', {
- *   distance: 3 * window.innerWidth,
- *   trigger:  { start: 'top top', end: 'bottom bottom' },
- *   easing:   'linear',
- * });
- */
-declare function scrollHorizontal(track: string | Element, options?: ScrollHorizontalOptions): ScrollHorizontalInstance;
-
-export { type ScrollHorizontalInstance, type ScrollHorizontalOptions, scrollHorizontal };

package/dist/lenis/index.d.mts

@@ -1,51 +0,0 @@
-/**
- * Lenis smooth-scroll adapter for svg-scroll-draw.
- *
- * Lenis v2+ patches `window.scrollY` natively — no adapter needed.
- * This adapter targets Lenis v1, which uses a virtual scroll value
- * and does NOT update `window.scrollY`. It patches `window.scrollY` /
- * `window.pageYOffset` so all svg-scroll-draw engines read the correct value.
- *
- * Usage:
- *   import Lenis from '@studio-freight/lenis'
- *   import { createLenisAdapter } from 'svg-scroll-draw/lenis'
- *
- *   const lenis = new Lenis()
- *   const adapter = createLenisAdapter(lenis)
- *
- *   // RAF loop — let Lenis drive the tick
- *   function raf(time: number) {
- *     lenis.raf(time)
- *     requestAnimationFrame(raf)
- *   }
- *   requestAnimationFrame(raf)
- *
- *   // On cleanup:
- *   adapter.destroy()
- */
-interface LenisScrollEvent {
-    scroll: number;
-    velocity: number;
-    direction: number;
-    progress: number;
-}
-interface LenisLike {
-    on(event: 'scroll', callback: (e: LenisScrollEvent) => void): void;
-    off(event: 'scroll', callback: (e: LenisScrollEvent) => void): void;
-}
-interface LenisAdapterInstance {
-    /** Restore native `window.scrollY` and remove the Lenis listener. */
-    destroy: () => void;
-    /** Returns the current virtual scroll Y value Lenis last reported. */
-    getScrollY: () => number;
-}
-/**
- * Patches `window.scrollY` and `window.pageYOffset` to return Lenis's
- * virtual scroll position so all svg-scroll-draw engines stay in sync
- * with smooth scroll.
- *
- * Only needed for Lenis v1. Lenis v2+ patches scrollY itself.
- */
-declare function createLenisAdapter(lenis: LenisLike): LenisAdapterInstance;
-
-export { type LenisAdapterInstance, type LenisLike, type LenisScrollEvent, createLenisAdapter };

package/dist/lenis/index.d.ts

@@ -1,51 +0,0 @@
-/**
- * Lenis smooth-scroll adapter for svg-scroll-draw.
- *
- * Lenis v2+ patches `window.scrollY` natively — no adapter needed.
- * This adapter targets Lenis v1, which uses a virtual scroll value
- * and does NOT update `window.scrollY`. It patches `window.scrollY` /
- * `window.pageYOffset` so all svg-scroll-draw engines read the correct value.
- *
- * Usage:
- *   import Lenis from '@studio-freight/lenis'
- *   import { createLenisAdapter } from 'svg-scroll-draw/lenis'
- *
- *   const lenis = new Lenis()
- *   const adapter = createLenisAdapter(lenis)
- *
- *   // RAF loop — let Lenis drive the tick
- *   function raf(time: number) {
- *     lenis.raf(time)
- *     requestAnimationFrame(raf)
- *   }
- *   requestAnimationFrame(raf)
- *
- *   // On cleanup:
- *   adapter.destroy()
- */
-interface LenisScrollEvent {
-    scroll: number;
-    velocity: number;
-    direction: number;
-    progress: number;
-}
-interface LenisLike {
-    on(event: 'scroll', callback: (e: LenisScrollEvent) => void): void;
-    off(event: 'scroll', callback: (e: LenisScrollEvent) => void): void;
-}
-interface LenisAdapterInstance {
-    /** Restore native `window.scrollY` and remove the Lenis listener. */
-    destroy: () => void;
-    /** Returns the current virtual scroll Y value Lenis last reported. */
-    getScrollY: () => number;
-}
-/**
- * Patches `window.scrollY` and `window.pageYOffset` to return Lenis's
- * virtual scroll position so all svg-scroll-draw engines stay in sync
- * with smooth scroll.
- *
- * Only needed for Lenis v1. Lenis v2+ patches scrollY itself.
- */
-declare function createLenisAdapter(lenis: LenisLike): LenisAdapterInstance;
-
-export { type LenisAdapterInstance, type LenisLike, type LenisScrollEvent, createLenisAdapter };