Aloitus
Asenna Glaze ja käyttämäsi animaatiomoottori:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP ja Motion ovat valinnaisia vertaisriippuvuuksia. Glaze ei sisällä kumpaakaan moottoria.
Alusta kerran
Kutsu glaze() sen jälkeen, kun elementit ovat DOM:ssa. Anna moottori ja koko määritys yhdellä kutsulla:
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>
Tämä käy juuren läpi ja luo sen animaatiot. Jos kutsut glaze() uudelleen, luodaan toinen instanssi; määritystä ei lisätä olemassa olevaan instanssiin.
Nimenomainen sovitin API vastaa asetusta GSAP:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
Käytä Motionin kanssa asetusta createMotionAdapter({ animate, stagger }) paketista glazejs/motion. Katso Motion-oppaasta asennusohjeet ja tuetut ominaisuudet. Valitse yhteen määritykseen joko adapter tai lib.
Asetukset
| Valinta | Oletusarvo | Tarkoitus |
|---|---|---|
lib.gsap.core |
ei mitään | GSAP-instanssi alkuperäistä määritystä API varten. |
adapter |
ei mitään | Nimenomainen GSAP- tai Motion-sovitin; vaihtoehto asetukselle lib. |
element |
document |
DOM-juuri, jonka läpi käydään ja jota tarkkaillaan. |
dataAttribute |
"data-animate" |
Animaatioapuluokat sisältävä attribuutti. |
className |
ei mitään | Apuluokkasynnaksin etuliite: luokkasynntaksi. |
breakpoints |
{ default: "(min-width: 1px)" } |
Nimetyt mediakyselyt. |
defaults.tl |
ei mitään | Aikajanan oletusasetukset. |
defaults.element |
ei mitään | Animaation oletusominaisuudet; elementin apuluokat ovat etusijalla. |
presets |
ei mitään | Nimetyt, uudelleenkäytettävät animaatiojonot. |
watch |
false |
Tarkkaile DOM-muutoksia; true käyttää 500 ms:n viivettä, tai anna arvo { debounceTime }. |
Tarkkailutila seuraa juuren sisällä lapsielementtien lisäyksiä ja poistoja sekä animaatioattribuuttien muutoksia. Luokkatilassa se seuraa myös luokkamuutoksia. Olennainen DOM-muutos ajastaa viivästetyn uudelleenrakennuksen. Animaatioon liittyvien sisäisten tyylien muutokset eivät käynnistä uudelleenrakennusta.
Päivitys ja siivous
Säilytä palautettu instanssi elinkaaren hallintaa varten:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() rakentaa uudelleen alkuperäisellä kokoonpanolla. destroy() pysäyttää animaatiot, poistaa tarkkailijat ja media query -kuuntelijat sekä palauttaa alkuperäiset inline-tyylit. Sen kutsuminen useammin kuin kerran on turvallista. Tuhottua instanssia ei voi käynnistää uudelleen komennolla refresh(); luo uusi instanssi, kun liität sen uudelleen.
Paluuarvo sisältää myös timelines, breakpoints ja ratkaistun arvon state. Jokainen aikajanan merkintä tallentaa moottorin aikajanan, tunnisteen, media queryn, juurielementin, asetukset ja animoidut elementit. Pidä moottorikohtaiset toiston ohjauskutsut koodissa, joka tietää, mikä sovitin loi instanssin.
Päivitykset ja responsiiviset uudelleenrakennukset voivat korvata natiivit aikajanaoliot. Lue nykyinen timelines[index].timeline, kun ohjaat toistoa uudelleenrakennuksen jälkeen, sen sijaan että säilyttäisit viitteen aiempaan natiiviin aikajanaan.
CDN
Julkiset sisääntulopisteet ovat ES-moduuleja, ja ne voidaan ladata myös ESM-CDNsta:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })