gclass-anims 1.0.0-beta.2 → 1.0.0-beta.21

package/README.md

@@ -6,7 +6,7 @@ Framework-agnostic: works in vanilla JS, React, Vue, Svelte, or any bundler.
 
 ## Live demo
 
-https://saturn-sepehr.github.io/GClass/demo/index.html
+https://saturn-sepehr.github.io/GClass/
 
 ## Installation
 
@@ -62,7 +62,7 @@ export default {
 
 ## Usage
 
-Add utility classes to your markup. Everything is class-driven — no config.
+Add utility classes to your markup. Everything is class-driven - no config.
 
 ```html
 <div class="spawn-up">reveals sliding up on scroll</div>
@@ -98,5 +98,5 @@ customAnims.push({
 
 ## License
 
-MIT — except GSAP, which is used under the Webflow Standard No-Charge GSAP
-License and is not bundled or redistributed.
+MIT - except GSAP, which is used under the Webflow Standard No-Charge GSAP
+License and is not bundled or redistributed. See `LICENSE`.

package/index.d.ts

@@ -4,8 +4,28 @@
 
 // --- AnimToggle ------------------------------------------------------------
 
-/** Boots the GSAP animation system (idempotent). */
-export function initAnimations(): void
+export interface GClassConfig {
+  throttlePerFrame: number
+  fps: number
+}
+
+/**
+ * Boots the GSAP animation system (idempotent).
+ * @param throttlePerFrame - number of observer handlers allowed per rAF frame (0 = no throttling, default).
+ *   Also accepts initAnimations({throttlePerFrame, fps}) object overload.
+ * @param fps - GSAP ticker fps cap (0 = default rAF, e.g. 30 for low-end). 0/undefined = no cap.
+ */
+export function initAnimations(throttlePerFrame?: number | GClassConfig, fps?: number): void
+/**
+ * Change GClass runtime options on the fly without reload.
+ * gclassOpts(throttlePerFrame, fps) — both optional numbers, missing -> defaults (0).
+ * gclassOpts() resets to defaults (no throttle, default ticker).
+ * Also accepts gclassOpts({throttlePerFrame, fps}).
+ * Example low-end button: onClick={() => gclassOpts(1, 30)}
+ */
+export function gclassOpts(throttlePerFrame?: number | GClassConfig, fps?: number): GClassConfig
+export function getGClassConfig(): GClassConfig
+export function subscribeGClassConfig(cb: (cfg: GClassConfig) => void): () => void
 /** Toggle animations on/off and reload the page. */
 export function toggleAnimations(): void
 /** Force animations off (wins over any stored preference) and reload. */
@@ -27,8 +47,13 @@ export function registerComplete(name: string, fn: CompleteHandler): CompleteHan
 /**
  * Boot the engine directly, bypassing AnimToggle. Returns a teardown function
  * that removes all listeners/observers/tweens created by this run.
+ * Pass a root to scope to that subtree (used for .boot-up).
+ * @param root - scope root (Document or HTMLElement)
+ * @param throttlePerFrame - number of observer handlers allowed per rAF frame.
+ *   0/undefined = no throttling (default). 1 = 1 observer per frame round-robin.
+ *   Overload: initListeners(throttlePerFrame) is also supported (root defaults to document).
  */
-export default function initListeners(): () => void
+export default function initListeners(root?: Document | HTMLElement | number, throttlePerFrame?: number): () => void
 
 // --- onComplete config -----------------------------------------------------
 
@@ -64,6 +89,10 @@ export interface AnimationConfig {
   typewriter?: boolean
   /** Marks a per-part (SplitText) typewriter entry. */
   typewriterSplit?: boolean
+  /** Marks a numeric counter entry (counts from `.spawn-num-N` to the element's number). */
+  count?: boolean
+  /** Marks a ScrambleText entry (text resolves out of garbage characters). */
+  scramble?: boolean
   /** Set false to skip generating a `.spawn-text-<name>` variant. Default true. */
   text?: boolean
   /** Set false to keep `build` but skip the always-on repeat. Default true. */
@@ -79,6 +108,8 @@ export interface SpawnConfig {
   play: (el: HTMLElement, delay: number, dur: number, ease: string) => any
   typewriter?: boolean
   typewriterSplit?: boolean
+  count?: boolean
+  scramble?: boolean
   text: boolean
 }
 
@@ -115,6 +146,9 @@ export interface Defaults {
   textStagger: number
   typewriterSplitCharDuration: number
   minTextPartDuration: number
+  revealDelay: number
+  characterlist: string
+  bootTime: number
 }
 
 /** Global timing / ease defaults (edit to tweak global behaviour). */
@@ -162,6 +196,40 @@ export function expandDown(target: TweenTarget, delay: number, dur: number, ease
 export function countUp(target: TweenTarget, delay: number, dur: number, ease: string): any
 /** Reads a count element's start (`.spawn-num-N`, else 0), target number, and decimals. */
 export function countTargetVars(target: TweenTarget): { start: number; end: number; decimals: number }
+/**
+ * Reads a scramble element's modifiers against the package defaults:
+ * `.amount-N` -> speed (default 1), `.reveal-delay-N` -> revealDelay
+ * (default `defaults.revealDelay`), `.chars-[...]` -> character pool verbatim
+ * (default `defaults.characterlist`). Also segments the element: only
+ * top-level text runs are scrambled (each wrapped in its own span); nested
+ * elements are preserved untouched.
+ */
+export function scrambleVars(target: TweenTarget): {
+  segs: { t: any; text: string }[]
+  chars: string
+  speed: number
+  revealDelay: number
+  rtl: boolean
+}
+/**
+ * Scramble spawn: the text starts empty and resolves into its real content
+ * through garbage characters (ScrambleTextPlugin). No opacity change; nested
+ * elements are preserved. Defaults to a linear ease so `.time-N` is the true
+ * total reveal time - an explicit `.ease-*` class overrides. Modifiers read
+ * from the element: .reveal-delay-N, .chars-[...], .amount-N, .scramble-all
+ * (whole-string scramble-and-sweep, no empty-start typing), .scramble-rtl.
+ */
+export function scramble(target: TweenTarget, delay: number, dur: number, ease: string): any
+/** Progressively draws the target's SVG stroke from 0% to 100% (strokes only). */
+export function drawsvg(target: TweenTarget, delay: number, dur: number, ease: string): any
+/**
+ * Splits multi-segment `<path>` elements (multiple "M" commands) into one
+ * single-segment `<path>` per segment. Destructive: source paths are replaced.
+ * Results are cached on the original element for engine re-inits.
+ */
+export function splitPaths(paths: any): any[]
+/** DrawSVG variant that splits multi-segment paths first, then draws each segment sequentially at constant speed. Returns a timeline. */
+export function drawsvgSplit(target: TweenTarget, delay: number, dur: number, ease: string): any
 export function verticalmove(target: TweenTarget, amount: number, dur: number, ease: string): any
 export function expandmove(target: TweenTarget, amount: number, dur: number, ease: string): any
 export function magnet(target: TweenTarget, x: number, y: number, scale: number, dur: number, ease: string): any
@@ -177,4 +245,5 @@ export function radiate(delay: number, target: TweenTarget, amount: number, dur:
 export function hover(delay: number, target: TweenTarget, amount: number, dur: number, ease: string): any
 export function marquee(target: TweenTarget, dir: string, duration: number, xOffset?: number, yOffset?: number, noRepeat?: boolean): any
 export function flip(state: any, ease: string, dur: number): any
-export function animatecss(target: TweenTarget, dur: number, delay: number, ease: string, propertyS: any, propertySValue: any, propertyE: any, propertyEValue: any): any
+export function animatecss(target: TweenTarget, dur: number, delay: number, ease: string, propertyS: any, propertySValue: any, propertyE: any, propertyEValue: any): any
+

package/index.js

@@ -1,4 +1,4 @@
-export { initAnimations, toggleAnimations, enableReducedMotion, disableReducedMotion } from './AnimToggle.js'
+export { initAnimations, gclassOpts, getGClassConfig, subscribeGClassConfig, toggleAnimations, enableReducedMotion, disableReducedMotion } from './AnimToggle.js'
 export { default as initListeners, registerComplete } from './Listeners.js'
 export { customAnims } from './CustomAnims.js'
 export { defaults, animations, normalize } from './Config.js'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "gclass-anims",
-  "version": "1.0.0-beta.2",
-  "description": "A Tailwind-style utility layer on top of GSAP. Framework-agnostic — works in vanilla JS, React, Vue, Svelte, or any bundler.",
+  "version": "1.0.0-beta.21",
+  "description": "A Tailwind-style utility layer on top of GSAP. Framework-agnostic - works in vanilla JS, React, Vue, Svelte, or any bundler.",
   "type": "module",
   "main": "index.js",
   "module": "index.js",
@@ -22,7 +22,8 @@
     "Config.js",
     "CustomAnims.js",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "keywords": [
     "gsap",
@@ -39,9 +40,8 @@
     "url": "git+https://github.com/Saturn-sepehr/GClass.git",
     "directory": "/"
   },
-  "homepage": "https://saturn-sepehr.github.io/GClass/demo/index.html",
+  "homepage": "https://saturn-sepehr.github.io/GClass/",
   "dependencies": {
-    "gclass-anims": "^1.0.0-beta.1",
     "gsap": "^3.15.0"
   },
   "peerDependenciesMeta": {},