Zum Inhalt springen

Erste Schritte

Installiere Glaze und die Animations-Engine, die du verwendest:

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

GSAP und Motion sind optionale Peer-Abhängigkeiten. Glaze bündelt keine der beiden Engines.

Einmal initialisieren

Rufe glaze() auf, sobald sich deine Elemente im DOM befinden. Gib die Engine und die gesamte Konfiguration in einem Aufruf an:

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>

Dabei wird der Stamm durchsucht und werden seine Animationen erstellt. Ein erneuter Aufruf von glaze() erstellt eine weitere Instanz; er ergänzt nicht die Konfiguration einer vorhandenen Instanz.

Der explizite Adapter API ist für GSAP gleichwertig:

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

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

Verwende für Motion createMotionAdapter({ animate, stagger }) aus glazejs/motion. In der Motion-Anleitung findest du Informationen zur Einrichtung und zu den unterstützten Funktionen. Wähle adapter oder lib in einer einzigen Konfiguration.

Optionen

Option Standard Zweck
lib.gsap.core none GSAP-Instanz für die ursprüngliche Einrichtung API.
adapter none Expliziter GSAP- oder Motion-Adapter; Alternative zu lib.
element document Zu durchsuchender und zu überwachender DOM-Stamm.
dataAttribute "data-animate" Attribut mit Animations-Utilities.
className none Klassenpräfix für die Klassensyntax.
breakpoints { default: "(min-width: 1px)" } Benannte Media Queries.
defaults.tl none Standardwerte für Timelines.
defaults.element none Standardwerte für Animationseigenschaften; Utilities des Elements haben Vorrang.
presets none Benannte, wiederverwendbare Animationszeichenfolgen.
watch false DOM-Änderungen überwachen; true verwendet eine Entprellzeit von 500 ms oder übergib { debounceTime }.

Der Überwachungsmodus erfasst das Hinzufügen und Entfernen von untergeordneten Elementen sowie Änderungen an Animationsattributen innerhalb des Stamms. Im Klassenmodus erfasst er auch Änderungen an Klassen. Eine relevante DOM-Änderung plant einen erneuten Aufbau mit Entprellung. Änderungen an Inline-Animationsstilen lösen keinen erneuten Aufbau aus.

Aktualisieren und bereinigen

Bewahre die zurückgegebene Instanz für die Verwaltung des Lebenszyklus auf:

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

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

refresh() erstellt die Instanzen mit der ursprünglichen Konfiguration neu. destroy() stoppt die Animationen, entfernt Beobachter und Media-Query-Listener und stellt die ursprünglichen Inline-Stile wieder her. Der Aufruf ist mehrfach möglich. Eine zerstörte Instanz lässt sich mit refresh() nicht neu starten; erstelle beim erneuten Mounten eine neue Instanz.

Der Rückgabewert enthält außerdem timelines, breakpoints und das aufgelöste state. Jeder Timeline-Eintrag enthält die Engine-Timeline, ID, Media Query, das Stammelement, Einstellungen und animierte Elemente. Verwende enginespezifische Wiedergabeaufrufe in Code, der weiß, welcher Adapter die Instanz erstellt hat.

Aktualisierungen und responsive Neuerstellungen können die nativen Timeline-Objekte ersetzen. Lies nach einer Neuerstellung beim Steuern der Wiedergabe die aktuelle timelines[index].timeline aus, statt eine vorherige Referenz auf die native Timeline beizubehalten.

CDN

Die öffentlichen Einstiegspunkte sind ES-Module und können auch aus einem ESM CDN geladen werden:

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