Treci la conținut

Primii pași

Instalați Glaze și motorul de animație pe care îl folosiți:

Shell
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

GSAP și Motion sunt dependențe peer opționale. Glaze nu include niciunul dintre motoare.

Inițializați o singură dată

Apelați glaze() după ce elementele se află în DOM. Furnizați motorul și întreaga configurare într-un singur apel:

TypeScript
import glaze from "glazejs"
import { gsap } from "gsap"

const root = document.querySelector("#app")
if (!root) throw new Error("Missing application root")

const animations = glaze({
  lib: { gsap: { core: gsap } },
  element: root,
  breakpoints: { md: "(min-width: 768px)" },
  defaults: { element: "duration-0.6" },
  presets: { rise: "from:opacity-0|y-24" },
  watch: { debounceTime: 200 },
})
HTML
<div id="app">
  <div data-animate="preset-rise"></div>
  <div data-animate="@md:preset-rise from:duration-1"></div>
</div>

Aceasta scanează rădăcina și îi creează animațiile. Dacă apelați din nou glaze(), se creează o altă instanță; nu se adaugă configurarea la cea existentă.

Adaptorul explicit API este echivalent pentru GSAP:

TypeScript
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"

const animations = glaze({ adapter: createGsapAdapter(gsap) })

Pentru Motion, folosiți createMotionAdapter({ animate, stagger }) din glazejs/motion. Consultați Ghidul Motion pentru configurare și funcționalitățile acceptate. Alegeți fie adapter, fie lib într-o singură configurare.

Opțiuni

Opțiune Valoare implicită Scop
lib.gsap.core niciuna Instanța GSAP pentru configurarea originală API.
adapter niciuna Adaptor GSAP explicit sau Motion; alternativă la lib.
element document Rădăcina DOM de scanat și monitorizat.
dataAttribute "data-animate" Atributul care conține utilitarele de animație.
className niciuna Prefixul clasei pentru sintaxa clasă.
breakpoints { default: "(min-width: 1px)" } Interogări media cu nume.
defaults.tl niciuna Setările implicite ale cronologiei.
defaults.element niciuna Proprietățile implicite ale animației; utilitarele elementului au prioritate.
presets niciuna Șiruri de animație reutilizabile cu nume.
watch false Monitorizează modificările DOM; true folosește o întârziere de 500 ms, sau transmiteți { debounceTime }.

Modul de monitorizare detectează adăugarea sau eliminarea elementelor copil și modificările atributelor de animație din rădăcină. În modul cu clase, detectează și modificările claselor. O modificare relevantă în DOM programează o reconstruire întârziată. Modificările stilurilor de animație inline nu declanșează reconstruiri.

Reîmprospătare și curățare

Păstrați instanța returnată pentru gestionarea ciclului de viață:

TypeScript
// Rescan after rendering new elements when watch is disabled.
animations.refresh()

// On component unmount or page teardown:
animations.destroy()

refresh() reconstruiește folosind configurația inițială. destroy() oprește animațiile, elimină observatorii și ascultătorii de interogări media și restabilește stilurile inline inițiale. Poate fi apelată în siguranță de mai multe ori. O instanță distrusă nu poate fi repornită cu refresh(); creați o instanță nouă la remontare.

Valoarea returnată include și timelines, breakpoints și state rezolvat. Fiecare intrare din cronologie înregistrează cronologia motorului, ID-ul, interogarea media, elementul rădăcină, setările și elementele animate. Păstrați apelurile de redare specifice motorului în codul care știe ce adaptor a creat instanța.

Reîmprospătările și reconstruirile responsive pot înlocui obiectele native ale cronologiei. Citiți timelines[index].timeline curent când controlați redarea după o reconstruire, în loc să păstrați o referință la o cronologie nativă anterioară.

CDN

Punctele de intrare publice sunt module ES și pot fi încărcate și dintr-un CDN ESM:

JavaScript
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"

const animations = glaze({ lib: { gsap: { core: gsap } } })