ripppl 0.1.1 → 0.1.3

package/README.md

@@ -3,8 +3,8 @@
 <p align="center">Ripple displacement using WebGL over the DOM.</p>
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/Arman-Luthra/ripppl/main/demo_1.gif" alt="" width="49%" />
-  <img src="https://raw.githubusercontent.com/Arman-Luthra/ripppl/main/demo-2.gif" alt="" width="49%" />
+  <img src="https://raw.githubusercontent.com/Arman-Luthra/ripppl/main/media/demo-1.gif" alt="" width="49%" />
+  <img src="https://raw.githubusercontent.com/Arman-Luthra/ripppl/main/media/demo-2.gif" alt="" width="49%" />
 </p>
 
 ## Installation
@@ -36,9 +36,13 @@ The returned **handle** exposes:
 | Method | Purpose |
 |--------|---------|
 | `update(partial)` | Merge new tuning values (see parameters below). |
-| `trigger({ x?, y? })` | Start a ripple at normalized coordinates **0–1** inside the scope (default center). |
+| `trigger({ x?, y?, fromElement? })` | Start a ripple at normalized coordinates **0–1** inside the scope, or centered on `fromElement`. |
+| `invalidateCapture()` | Mark the frozen DOM snapshot stale (for example after layout or content changes). The next `trigger` will capture again unless you prefetch first. |
+| `prefetchCapture()` | Start a background capture while the DOM is in a known-good state. Use when you know you will call `trigger` soon so capture work overlaps with transitions, loaders, or countdowns instead of blocking the first frame of the ripple. |
 | `destroy()` | Remove listeners, overlay, and WebGL resources. |
 
+Export **`RIPPPL_CAPTURE_IGNORE_ATTR`**: the attribute name (`data-ripppl-overlay`) placed on the WebGL overlay and on any element that must be omitted from the snapshot. Apply it to temporary UI that should not appear in the captured texture while `prefetchCapture` runs.
+
 Types: `RippleOptions`, `RippleTuning`, `RippleHandle` are exported from the package.
 
 ## Parameters

package/dist/ripppl.d.ts

@@ -14,13 +14,18 @@ export type RippleTuning = {
 };
 export type RippleOptions = RippleTuning & {
     scope?: string | HTMLElement;
+    exclude?: boolean | TriggerInput;
 };
+export declare const RIPPPL_CAPTURE_IGNORE_ATTR = "data-ripppl-overlay";
 export type RippleHandle = {
     destroy: () => void;
     update: (opts: Partial<RippleTuning>) => void;
+    invalidateCapture: () => void;
+    prefetchCapture: () => void;
     trigger: (opts?: {
         x?: number;
         y?: number;
+        fromElement?: HTMLElement;
     }) => void;
 };
 type TriggerInput = string | HTMLElement | NodeListOf<HTMLElement> | HTMLElement[];

package/dist/ripppl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ripppl.d.ts","sourceRoot":"","sources":["../src/ripppl.ts"],"names":[],"mappings":"AAwFA,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;CAC9B,CAAC;AAgBF,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;IAC9C,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE;QAAE,CAAC,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;CACtD,CAAC;AAEF,KAAK,YAAY,GACb,MAAM,GACN,WAAW,GACX,UAAU,CAAC,WAAW,CAAC,GACvB,WAAW,EAAE,CAAC;AA0JlB,wBAAgB,YAAY,CAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,GAAE,aAAkB,GAC1B,YAAY,CAuWd"}
+{"version":3,"file":"ripppl.d.ts","sourceRoot":"","sources":["../src/ripppl.ts"],"names":[],"mappings":"AAyFA,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG;IACzC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,GAAG,YAAY,CAAC;CAClC,CAAC;AAEF,eAAO,MAAM,0BAA0B,wBAAwB,CAAC;AAgBhE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;IAC9C,iBAAiB,EAAE,MAAM,IAAI,CAAC;IAC9B,eAAe,EAAE,MAAM,IAAI,CAAC;IAC5B,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE;QACf,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B,KAAK,IAAI,CAAC;CACZ,CAAC;AAEF,KAAK,YAAY,GACb,MAAM,GACN,WAAW,GACX,UAAU,CAAC,WAAW,CAAC,GACvB,WAAW,EAAE,CAAC;AA0XlB,wBAAgB,YAAY,CAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,GAAE,aAAkB,GAC1B,YAAY,CAspBd"}