Kezdő lépések
Telepítse a Glaze csomagot és az Ön által használt animációs motort:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
A GSAP és a Motion opcionális peer dependency. A Glaze egyik motort sem csomagolja magába.
Egyszeri inicializálás
Hívja meg a glaze() függvényt, miután az elemek bekerültek a DOM-ba. A motort és az összes konfigurációt egyetlen hívásban adja meg:
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 },
})
<div id="app">
<div data-animate="preset-rise"></div>
<div data-animate="@md:preset-rise from:duration-1"></div>
</div>
Ez átvizsgálja a gyökérelemet, és létrehozza az animációit. Ha ismét meghívja a glaze() függvényt, új példány jön létre; a konfiguráció nem adódik hozzá egy meglévő példányhoz.
Az explicit API adapter a GSAP esetén egyenértékű:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
Motion használatához a glazejs/motion csomagból használja a createMotionAdapter({ animate, stagger }) elemet. A beállításról és a támogatott funkciókról lásd a Motion útmutatót. Egyetlen konfigurációban a adapter vagy a lib közül válasszon.
Beállítások
| Beállítás | Alapérték | Cél |
|---|---|---|
lib.gsap.core |
nincs | GSAP példány az eredeti beállításhoz API. |
adapter |
nincs | Explicit GSAP vagy Motion adapter; a lib alternatívája. |
element |
document |
Átvizsgálandó és megfigyelendő DOM-gyökérelem. |
dataAttribute |
"data-animate" |
Az animációs segédosztályokat tartalmazó attribútum. |
className |
nincs | Osztályprefix a osztályszintaxishoz. |
breakpoints |
{ default: "(min-width: 1px)" } |
Elnevezett médiakérdések. |
defaults.tl |
nincs | Alapértelmezett idővonal-beállítások. |
defaults.element |
nincs | Alapértelmezett animációs tulajdonságok; az elem segédosztályai elsőbbséget élveznek. |
presets |
nincs | Elnevezett, újrafelhasználható animációs karakterláncok. |
watch |
false |
DOM-változások figyelése; a true 500 ms késleltetést használ, vagy adja meg a { debounceTime } értéket. |
A figyelő mód a gyökérelemen belül figyeli a gyermekelemek hozzáadását és eltávolítását, valamint az animációs attribútumok változását. Osztálymódban az osztályváltozásokat is figyeli. A releváns DOM-módosítás késleltetett újraépítést ütemez. Az animációs inline stílusok változása nem indít újraépítést.
Frissítés és tisztítás
Az életciklus kezeléséhez őrizze meg a visszaadott példányt:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() újraépíti az eredeti konfigurációval. A destroy() leállítja az animációkat, eltávolítja a megfigyelőket és a médiakérdés-figyelőket, majd visszaállítja az eredeti inline stílusokat. Többször is biztonságosan meghívható. A megsemmisített példány a refresh() segítségével nem indítható újra; újbóli csatlakoztatáskor hozzon létre új példányt.
A visszatérési érték tartalmazza a timelines, a breakpoints és a feloldott state értékét is. Minden idővonal-bejegyzés rögzíti a motor idővonalát, azonosítóját, médiakérdését, gyökérelemét, beállításait és animált elemeit. A motorspecifikus lejátszási hívásokat olyan kódban tartsa, amely tudja, melyik adapter hozta létre a példányt.
A frissítések és az adaptív újraépítések lecserélhetik a natív idővonal-objektumokat. Újraépítés után a lejátszás vezérlésekor olvassa be az aktuális timelines[index].timeline értéket, és ne őrizze meg a korábbi natív idővonalra mutató hivatkozást.
CDN
A nyilvános belépési pontok ES-modulok, és ESM CDN formájában is betölthetők:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })