Kom godt i gang
Installer Glaze og den animationsmotor, du bruger:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP og Motion er valgfrie peer-afhængigheder. Glaze inkluderer ingen af motorerne.
Initialiser én gang
Kald glaze(), når elementerne er i DOM'en. Angiv motoren og al konfiguration
i ét kald:
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>
Dette scanner roden og opretter dens animationer. Hvis du kalder glaze() igen, oprettes
en ny instans; konfigurationen føjes ikke til en eksisterende.
Den eksplicitte adapter API er tilsvarende for GSAP:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
For Motion skal du bruge createMotionAdapter({ animate, stagger }) fra
glazejs/motion. Se Motion-vejledningen for opsætning og understøttede
funktioner. Vælg enten adapter eller lib i én enkelt konfiguration.
Indstillinger
| Valgmulighed | Standard | Formål |
|---|---|---|
lib.gsap.core |
ingen | GSAP-instans til den oprindelige opsætning API. |
adapter |
ingen | Eksplicit GSAP- eller Motion-adapter; alternativ til lib. |
element |
document |
DOM-rod, der skal scannes og overvåges. |
dataAttribute |
"data-animate" |
Attribut, der indeholder animationsutilities. |
className |
ingen | Klassepræfiks til klassesyntaks. |
breakpoints |
{ default: "(min-width: 1px)" } |
Navngivne medieforespørgsler. |
defaults.tl |
ingen | Standardindstillinger for tidslinjer. |
defaults.element |
ingen | Standardindstillinger for animationsegenskaber; elementets utilities har forrang. |
presets |
ingen | Navngivne genanvendelige animationsstrenge. |
watch |
false |
Overvåg ændringer i DOM'en; true bruger en debounce på 500 ms, eller angiv { debounceTime }. |
Overvågningstilstand registrerer tilføjelser og fjernelser af underordnede elementer samt ændringer i animationsattributter inden for roden. I klassetilstand registrerer den også ændringer i klasser. En relevant DOM- ændring planlægger en genopbygning efter en debounce. Ændringer i inline-animationsstile udløser ikke genopbygninger.
Opdatering og oprydning
Gem den returnerede instans til håndtering af livscyklussen:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() genopbygger med den oprindelige konfiguration. destroy() stopper animationerne, fjerner observers og media query-lyttere og gendanner de oprindelige inline-stile. Det er sikkert at kalde funktionen flere gange. En destrueret instans kan ikke genstartes med refresh(); opret en ny instans, når den monteres igen.
Returværdien indeholder også timelines, breakpoints og den løste state. Hvert tidslinjeelement registrerer sin engine-tidslinje, sit ID, sin media query, sit rodelement, sine indstillinger og sine animerede elementer. Hold engine-specifikke afspilningskald i kode, der ved, hvilken adapter der oprettede instansen.
Opdateringer og responsive genopbygninger kan erstatte de native tidslinjeobjekter. Læs den aktuelle timelines[index].timeline, når du styrer afspilningen efter en genopbygning, i stedet for at beholde en tidligere reference til en native tidslinje.
CDN
De offentlige indgangspunkter er ES-moduler og kan også indlæses fra en 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 } } })