Darba sākšana
Instalējiet Glaze un izmantoto animācijas dzinēju:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP un Motion ir neobligātas vienādranga atkarības. Glaze neiekļauj nevienu no dzinējiem.
Inicializējiet vienreiz
Izsauciet glaze() pēc elementu ievietošanas DOM. Norādiet dzinēju un visu konfigurāciju vienā izsaukumā:
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>
Tiek pārbaudīts saknes elements un izveidotas tā animācijas. Atkārtoti izsaucot glaze(), tiek izveidota vēl viena instance; konfigurācija netiek pievienota esošai instancei.
Skaidri norādītais adapteris API ir līdzvērtīgs adapterim GSAP:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
Lai izmantotu Motion, lietojiet createMotionAdapter({ animate, stagger }) no glazejs/motion. Iestatīšanu un atbalstītās funkcijas skatiet Motion rokasgrāmatā. Vienā konfigurācijā izvēlieties vai nu adapter, vai lib.
Opcijas
| Opcija | Noklusējums | Mērķis |
|---|---|---|
lib.gsap.core |
nav | GSAP instance sākotnējai iestatīšanai API. |
adapter |
nav | Skaidri norādīts GSAP vai Motion adapteris; alternatīva opcijai lib. |
element |
document |
DOM saknes elements, ko pārbaudīt un novērot. |
dataAttribute |
"data-animate" |
Atribūts, kurā norādītas animācijas utilītas. |
className |
nav | Klases prefikss sintaksei klašu sintakse. |
breakpoints |
{ default: "(min-width: 1px)" } |
Nosaukti multivides vaicājumi. |
defaults.tl |
nav | Laika skalas noklusējuma iestatījumi. |
defaults.element |
nav | Animācijas īpašību noklusējuma vērtības; elementa utilītām ir augstāka prioritāte. |
presets |
nav | Nosauktas, atkārtoti izmantojamas animācijas virknes. |
watch |
false |
DOM izmaiņu novērošana; true izmanto 500 ms aizkavi, vai arī norādiet { debounceTime }. |
Novērošanas režīmā saknes elementā tiek novēroti bērnelementu pievienojumi un noņemšana, kā arī animācijas atribūtu izmaiņas. Klašu režīmā tiek novērotas arī klašu izmaiņas. Atbilstošas DOM izmaiņas ieplāno atkārtotu izveidi ar aizkavi. Animācijas elementa stila izmaiņas atkārtotu izveidi neizraisa.
Atsvaidzināšana un tīrīšana
Saglabājiet atgriezto instanci dzīves cikla pārvaldībai:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() no jauna izveido, izmantojot sākotnējo konfigurāciju. destroy() aptur animācijas, noņem novērotājus un multivides vaicājumu klausītājus, kā arī atjauno sākotnējos iekļautos stilus. To var droši izsaukt vairāk nekā vienu reizi. Iznīcinātu instanci nevar palaist no jauna ar refresh(); montējot vēlreiz, izveidojiet jaunu instanci.
Atgrieztajā vērtībā ir arī timelines, breakpoints un atrisinātais state. Katrā laika skalas ierakstā ir norādīta dzinēja laika skala, ID, multivides vaicājums, saknes elements, iestatījumi un animētie elementi. Dzinējam specifiskus atskaņošanas izsaukumus glabājiet kodā, kas zina, kurš adapteris izveidoja instanci.
Atsvaidzināšanas un adaptīvas pārbūves laikā vietējos laika skalas objektus var aizstāt. Pēc pārbūves, vadot atskaņošanu, nolasiet pašreizējo timelines[index].timeline, nevis saglabājiet iepriekšējo vietējās laika skalas atsauci.
CDN
Publiskie ieejas punkti ir ES moduļi, un tos var ielādēt arī no ESM CDN:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })