Hoppa till innehåll

Kom igång

Installera Glaze och den animeringsmotor du använder:

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

GSAP och Motion är valfria peer dependencies. Glaze paketerar ingen av motorerna.

Initiera en gång

Anropa glaze() när dina element finns i DOM:en. Ange motorn och all konfiguration i ett enda anrop:

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>

Detta genomsöker roten och skapar dess animationer. Om du anropar glaze() igen skapas en ny instans; konfigurationen läggs inte till i en befintlig instans.

Den uttryckliga adaptern API är likvärdig för GSAP:

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

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

För Motion använder du createMotionAdapter({ animate, stagger }) från glazejs/motion. Se Motion-guiden för konfiguration och funktioner som stöds. Välj antingen adapter eller lib i en enda konfiguration.

Alternativ

Alternativ Standardvärde Syfte
lib.gsap.core inget GSAP-instans för den ursprungliga konfigurationen API.
adapter inget Uttrycklig GSAP- eller Motion-adapter; alternativ till lib.
element document DOM-rot att genomsöka och övervaka.
dataAttribute "data-animate" Attribut som innehåller animeringsverktyg.
className inget Klassprefix för klassyntax.
breakpoints { default: "(min-width: 1px)" } Namngivna mediefrågor.
defaults.tl inget Standardinställningar för tidslinjer.
defaults.element inget Standardvärden för animeringsegenskaper; verktyg på element har företräde.
presets inget Namngivna återanvändbara animeringssträngar.
watch false Övervaka DOM-ändringar; true använder en debounce på 500 ms, eller skicka { debounceTime }.

Övervakningsläget observerar tillägg och borttagning av underordnade element samt ändringar i animeringsattribut inom roten. I klassläge observerar det även klassändringar. En relevant DOM-mutation schemalägger en ombyggnad med debounce. Ändringar av inline-stilar för animation utlöser inte ombyggnader.

Uppdatering och rensning

Spara den returnerade instansen för livscykelhantering:

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

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

refresh() bygger om med den ursprungliga konfigurationen. destroy() stoppar animationerna, tar bort observatörer och mediafrågeavlyssnare och återställer ursprungliga inline-format. Det går bra att anropa flera gånger. En förstörd instans kan inte startas om med refresh(); skapa en ny instans när den monteras igen.

Returvärdet innehåller också timelines, breakpoints och den lösta state. Varje tidslinjepost registrerar motorns tidslinje, ID, mediafråga, rotelement, inställningar och animerade element. Använd motorspecifika uppspelningsanrop i kod som vet vilken adapter som skapade instansen.

Uppdateringar och responsiva ombyggnader kan ersätta de inbyggda tidslinjeobjekten. Läs aktuella timelines[index].timeline när du styr uppspelningen efter en ombyggnad, i stället för att behålla en tidigare referens till en inbyggd tidslinje.

CDN

De publika ingångspunkterna är ES-moduler och kan även laddas från en ESM CDN:

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