Ga naar de inhoud

Aan de slag

Installeer Glaze en de animatie-engine die je gebruikt:

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

GSAP en Motion zijn optionele peer dependencies. Glaze bundelt geen van beide engines.

Eenmalig initialiseren

Roep glaze() aan nadat je elementen in de DOM staan. Geef de engine en alle configuratie mee in één aanroep:

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>

Hiermee wordt de root gescand en worden de animaties ervan aangemaakt. Als je glaze() opnieuw aanroept, wordt er een nieuwe instantie gemaakt; de configuratie wordt niet toegevoegd aan een bestaande instantie.

De expliciete adapter API is gelijkwaardig voor GSAP:

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

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

Gebruik voor Motion createMotionAdapter({ animate, stagger }) uit glazejs/motion. Raadpleeg de Motion-handleiding voor de configuratie en ondersteunde functies. Kies adapter of lib in één configuratie.

Opties

Optie Standaard Doel
lib.gsap.core geen GSAP-instantie voor de oorspronkelijke configuratie API.
adapter geen Expliciete GSAP- of Motion-adapter; alternatief voor lib.
element document DOM-root om te scannen en te observeren.
dataAttribute "data-animate" Attribuut met animatie-utilities.
className geen Klasseprefix voor klassensyntaxis.
breakpoints { default: "(min-width: 1px)" } Benoemde mediaquery's.
defaults.tl geen Standaardinstellingen voor tijdlijnen.
defaults.element geen Standaardeigenschappen voor animaties; elementutilities hebben voorrang.
presets geen Benoemde, herbruikbare animatiestrings.
watch false DOM-wijzigingen observeren; true gebruikt een debounce van 500 ms, of geef { debounceTime } door.

De waakmodus observeert toevoegingen en verwijderingen van onderliggende elementen en wijzigingen in animatieattributen binnen de root. In de klassenmodus observeert deze ook wijzigingen in klassen. Een relevante DOM-mutatie plant een gedebouncete heropbouw in. Wijzigingen in inline animatiestijlen leiden niet tot een heropbouw.

Vernieuwen en opschonen

Bewaar de geretourneerde instantie voor levenscyclusbeheer:

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

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

refresh() bouwt opnieuw op met de oorspronkelijke configuratie. destroy() stopt de animaties, verwijdert observers en mediaquerylisteners en herstelt de oorspronkelijke inline-stijlen. Je kunt dit veilig meerdere keren aanroepen. Een vernietigde instantie kan niet opnieuw worden gestart met refresh(); maak een nieuwe instantie wanneer je opnieuw mount.

De geretourneerde waarde bevat ook timelines, breakpoints en de opgeloste state. Elke tijdlijnvermelding bevat de tijdlijn van de engine, de ID, de mediaquery, het root-element, de instellingen en de geanimeerde elementen. Gebruik engine-specifieke afspeelaanroepen in code die weet welke adapter de instantie heeft gemaakt.

Vernieuwingen en responsieve heropbouw kunnen de native tijdlijnobjecten vervangen. Lees na een heropbouw de huidige timelines[index].timeline uit wanneer je de weergave aanstuurt, in plaats van een eerdere verwijzing naar een native tijdlijn te bewaren.

CDN

De openbare toegangspunten zijn ES-modules en kunnen ook vanuit een ESM CDN worden geladen:

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