Pierwsze kroki
Zainstaluj Glaze i używany silnik animacji:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP i Motion są opcjonalnymi zależnościami partnerskimi. Glaze nie dołącza żadnego z tych silników.
Inicjalizacja
Wywołaj glaze() po dodaniu elementów do DOM. W jednym wywołaniu przekaż silnik i całą konfigurację:
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>
Ta metoda skanuje wskazany element główny i tworzy jego animacje. Ponowne wywołanie glaze() tworzy kolejną instancję; nie dodaje konfiguracji do istniejącej.
Jawny adapter API jest równoważny dla GSAP:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
W przypadku Motion użyj createMotionAdapter({ animate, stagger }) z glazejs/motion. Informacje o konfiguracji i obsługiwanych funkcjach znajdziesz w przewodniku Motion. W jednej konfiguracji wybierz adapter lub lib.
Opcje
| Opcja | Domyślnie | Cel |
|---|---|---|
lib.gsap.core |
brak | Instancja GSAP dla pierwotnej konfiguracji API. |
adapter |
brak | Jawny adapter GSAP lub Motion; alternatywa dla lib. |
element |
document |
Główny element DOM do skanowania i obserwowania. |
dataAttribute |
"data-animate" |
Atrybut zawierający narzędzia animacji. |
className |
brak | Prefiks klasy dla składni klas. |
breakpoints |
{ default: "(min-width: 1px)" } |
Nazwane zapytania o media. |
defaults.tl |
brak | Domyślne ustawienia osi czasu. |
defaults.element |
brak | Domyślne właściwości animacji; narzędzia elementu mają pierwszeństwo. |
presets |
brak | Nazwane ciągi animacji wielokrotnego użytku. |
watch |
false |
Obserwowanie zmian w DOM; true używa opóźnienia 500 ms lub można przekazać { debounceTime }. |
Tryb obserwowania wykrywa dodawanie i usuwanie elementów potomnych oraz zmiany atrybutów animacji w obrębie elementu głównego. W trybie klas wykrywa także zmiany klas. Istotna mutacja DOM planuje przebudowę z opóźnieniem. Zmiany stylów animacji wbudowanych w element nie wywołują przebudowy.
Odświeżanie i sprzątanie
Zachowaj zwróconą instancję, aby zarządzać jej cyklem życia:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() przebudowuje animacje przy użyciu pierwotnej konfiguracji. destroy() zatrzymuje animacje, usuwa obserwatory i nasłuchiwacze zapytań o media oraz przywraca pierwotne style wbudowane. Można bezpiecznie wywołać tę metodę wielokrotnie. Zniszczonej instancji nie można ponownie uruchomić za pomocą refresh(); podczas ponownego montowania utwórz nową instancję.
Wartość zwracana zawiera również timelines, breakpoints oraz rozstrzygnięte state. Każdy wpis osi czasu zawiera oś czasu silnika, identyfikator, zapytanie o media, element główny, ustawienia i animowane elementy. Wywołania odtwarzania specyficzne dla silnika umieszczaj w kodzie, który wie, który adapter utworzył instancję.
Odświeżenia i przebudowy responsywne mogą zastąpić natywne obiekty osi czasu. Po przebudowie, sterując odtwarzaniem, odczytaj bieżące timelines[index].timeline zamiast zachowywać poprzednie odwołanie do natywnej osi czasu.
CDN
Publiczne punkty wejścia są modułami ES i można je również załadować z CDN ESM:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })