Preskoči na vsebino

Začetek

Namestite Glaze in mehanizem za animacije, ki ga uporabljate:

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

GSAP in Motion sta neobvezni odvisnosti enakovrednih paketov. Glaze ne vključuje nobenega od teh mehanizmov.

Enkratna inicializacija

Ko so elementi že v DOM-u, pokličite glaze(). Mehanizem in celotno konfiguracijo podajte v enem klicu:

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>

S tem se pregleda korenski element in ustvarijo njegove animacije. Če glaze() pokličete znova, se ustvari nova instanca; konfiguracija se ne doda obstoječi instanci.

Izrecni adapter API je za GSAP enakovreden:

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

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

Za Motion uporabite createMotionAdapter({ animate, stagger }) iz glazejs/motion. Za nastavitev in podprte funkcije glejte navodila za Motion. V posamezni konfiguraciji izberite adapter ali lib.

Možnosti

Možnost Privzeto Namen
lib.gsap.core nič Instanca GSAP za prvotno nastavitev API.
adapter nič Izrecni adapter GSAP ali Motion; alternativa za lib.
element document Korenski element DOM-a za pregled in spremljanje.
dataAttribute "data-animate" Atribut, ki vsebuje pripomočke za animacije.
className nič Predpona razredov za sintakso razredov.
breakpoints { default: "(min-width: 1px)" } Poimenovane medijske poizvedbe.
defaults.tl nič Privzete nastavitve časovnice.
defaults.element nič Privzete lastnosti animacije; pripomočki elementa imajo prednost.
presets nič Poimenovani nizi animacij za ponovno uporabo.
watch false Spremljanje sprememb DOM-a; true uporablja zakasnitev v ms 500, ali pa podajte { debounceTime }.

Način spremljanja zaznava dodajanje in odstranjevanje podrejenih elementov ter spremembe atributov za animacije znotraj korenskega elementa. V načinu razredov zaznava tudi spremembe razredov. Ustrezna sprememba DOM-a sproži ponovno sestavljanje z zakasnitvijo. Spremembe slogov animacije v vrstici ne sprožijo ponovnega sestavljanja.

Osveževanje in čiščenje

Vrnjeno instanco shranite za upravljanje življenjskega cikla:

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

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

refresh() ponovno zgradi z izvirno konfiguracijo. destroy() ustavi animacije, odstrani opazovalnike in poslušalce medijskih poizvedb ter obnovi izvirne vdelane sloge. Klic je varen tudi večkrat. Uničenega primerka ni mogoče znova zagnati z refresh(); ob ponovni namestitvi ustvarite nov primerek.

Vrnjena vrednost vključuje tudi timelines, breakpoints in razrešeni state. Vsak vnos časovnice beleži časovnico pogona, ID, medijsko poizvedbo, korenski element, nastavitve in animirane elemente. Klice za predvajanje, specifične za posamezen pogon, uporabite v kodi, ki ve, kateri adapter je ustvaril primerek.

Osvežitve in odzivne ponovne gradnje lahko zamenjajo izvorne objekte časovnice. Pri upravljanju predvajanja po ponovni gradnji preberite trenutno vrednost timelines[index].timeline, namesto da obdržite sklic na prejšnjo izvorno časovnico.

CDN

Javne vstopne točke so moduli ES in jih je mogoče naložiti tudi iz ESM CDN:

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