Darbo pradžia
Įdiekite Glaze ir naudojamą animacijos variklį:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP ir Motion yra pasirenkamos tarpusavio priklausomybės. Glaze neįtraukia nė vieno variklio.
Inicijuokite vieną kartą
Kai elementai jau yra DOM, iškvieskite glaze(). Variklį ir visą konfigūraciją pateikite viename iškvietime:
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>
Taip peržiūrima šaknis ir sukuriamos jos animacijos. Dar kartą iškvietus glaze(), sukuriamas kitas egzempliorius; esamo egzemplioriaus konfigūracija nepapildoma.
Aiškiai nurodžius adapterį API, rezultatas GSAP atveju toks pat:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
„Motion“ atveju naudokite createMotionAdapter({ animate, stagger }) iš glazejs/motion. Sąranką ir palaikomas funkcijas rasite „Motion“ vadove. Vienoje konfigūracijoje pasirinkite adapter arba lib.
Parinktys
| Parinktis | Numatytoji reikšmė | Paskirtis |
|---|---|---|
lib.gsap.core |
none | GSAP egzempliorius pradinei sąrankai API. |
adapter |
none | Aiškiai nurodytas GSAP arba „Motion“ adapteris; alternatyva lib. |
element |
document |
DOM šaknis, kurią reikia peržiūrėti ir stebėti. |
dataAttribute |
"data-animate" |
Atributas, kuriame yra animacijos įrankiai. |
className |
none | Klasių prefiksas, skirtas klasių sintaksei. |
breakpoints |
{ default: "(min-width: 1px)" } |
Pavadintos medijos užklausos. |
defaults.tl |
none | Numatytieji laiko juostos nustatymai. |
defaults.element |
none | Numatytosios animacijos savybės; elementų įrankiai turi pirmenybę. |
presets |
none | Pavadintos daugkartinio naudojimo animacijos eilutės. |
watch |
false |
Stebėti DOM pakeitimus; true naudojamas 500 ms delsos apdorojimas arba perduokite { debounceTime }. |
Stebėjimo režimas aptinka šaknies elementų pridėjimą ir pašalinimą bei animacijos atributų pakeitimus. Naudojant klasių režimą, stebimi ir klasių pakeitimai. Aptikus reikšmingą DOM pakeitimą, suplanuojamas apdorojimas su delsa ir iš naujo sukuriamos animacijos. Įterptųjų animacijos stilių pakeitimai jų kūrimo iš naujo nesukelia.
Atnaujinimas ir išvalymas
Gyvavimo ciklui valdyti išsaugokite grąžintą egzempliorių:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() atkuria naudojant pradinę konfigūraciją. destroy() sustabdo animacijas, pašalina stebėtojus ir medijos užklausų klausytojus bei atkuria pradinius įterptinius stilius. Šį metodą saugu iškviesti kelis kartus. Sunaikinto egzemplioriaus negalima paleisti iš naujo naudojant refresh(); kurdami komponentą iš naujo, sukurkite naują egzempliorių.
Grąžinamoje reikšmėje taip pat yra timelines, breakpoints ir išspręstas state. Kiekviename laiko juostos įraše nurodoma jo variklio laiko juosta, ID, medijos užklausa, šakninis elementas, nustatymai ir animuojami elementai. Varikliui būdingus atkūrimo iškvietimus laikykite kode, žinančiame, kuris adapteris sukūrė egzempliorių.
Atnaujinus arba iš naujo sukūrus prisitaikančią versiją, savieji laiko juostos objektai gali būti pakeisti. Valdydami atkūrimą po atkūrimo iš naujo, perskaitykite dabartinį timelines[index].timeline, o ne naudokite išsaugotą ankstesnę savosios laiko juostos nuorodą.
CDN
Viešieji įvesties taškai yra ES moduliai; juos taip pat galima įkelti iš 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 } } })