Liigu sisu juurde

Alustamine

Paigaldage Glaze ja kasutatav animatsioonimootor:

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

GSAP ja Motion on valikulised kaaslasesõltuvused. Glaze ei komplekteeri kumbagi mootorit.

Lähtesta üks kord

Kutsuge glaze() välja pärast elementide lisamist DOM-i. Edastage mootor ja kogu seadistus ühe väljakutsega:

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>

See skannib juurelementi ja loob selle animatsioonid. glaze() uuesti kutsumine loob uue eksemplari; see ei lisa seadistust olemasolevale eksemplarile.

Selgesõnaline adapter API on GSAP puhul samaväärne:

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

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

Motioni puhul kasutage createMotionAdapter({ animate, stagger })-i asukohast glazejs/motion. Seadistuse ja toetatud funktsioonide kohta vt Motioni juhendit. Valige ühes konfiguratsioonis kas adapter või lib.

Suvandid

Suvand Vaikimisi Eesmärk
lib.gsap.core puudub GSAP algse seadistuse eksemplar API.
adapter puudub Selgesõnaline GSAP või Motioni adapter; alternatiiv väärtusele lib.
element document Skannitav ja jälgitav DOM-i juurelement.
dataAttribute "data-animate" Animatsiooniutiliite sisaldav atribuut.
className puudub Klassi eesliide klassisüntaksi jaoks.
breakpoints { default: "(min-width: 1px)" } Nimega meediapäringud.
defaults.tl puudub Ajaskaala vaikesätted.
defaults.element puudub Animatsiooni vaikeomadused; elemendi utiliidid on ülimuslikud.
presets puudub Nimega korduskasutatavad animatsioonistringid.
watch false Jälgi DOM-i muudatusi; true kasutab 500 ms viivitust, või edasta { debounceTime }.

Jälgimisrežiim jälgib juurelemendi sees alamüksuste lisamist ja eemaldamist ning animatsiooniatribuutide muudatusi. Klassirežiimis jälgib see ka klassimuudatusi. Asjakohane DOM-i muudatus käivitab viivitusega taasloomise. Animatsiooni tekstisisesed stiilimuudatused ei käivita taasloomist.

Värskendamine ja puhastamine

Hoidke tagastatud eksemplari elutsükli haldamiseks alles:

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

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

refresh() loob uuesti algse konfiguratsiooni põhjal. destroy() peatab animatsioonid, eemaldab vaatlejad ja meediumipäringute kuulajad ning taastab algsed tekstisisesed stiilid. Seda võib ohutult kutsuda mitu korda. Hävitamise järel ei saa eksemplari funktsiooniga refresh() uuesti käivitada; uuesti lisamisel looge uus eksemplar.

Tagastusväärtus sisaldab ka timelines, breakpoints ja lahendatud väärtust state. Iga ajaskaala kirje talletab mootori ajaskaala, ID, meediumipäringu, juurelemendi, seaded ja animeeritavad elemendid. Hoidke mootoripõhised taasesituskutsed koodis, mis teab, milline adapter eksemplari lõi.

Värskendused ja kohanduvad taasloomised võivad asendada algsed ajaskaalaobjektid. Pärast taasloomist lugege taasesituse juhtimiseks kehtivat väärtust timelines[index].timeline, selle asemel et kasutada varasemat algse ajaskaala viidet.

CDN

Avalikud sisenemispunktid on ES-moodulid ja neid saab laadida ka ESM CDN kaudu:

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 } } })