Preskočiť na obsah

Začíname

Nainštalujte Glaze a animačný engine, ktorý používate:

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

GSAP a Motion sú voliteľné peer závislosti. Glaze neobsahuje ani jeden z týchto enginov.

Inicializujte raz

Po vložení prvkov do DOM zavolajte glaze(). Engine aj celú konfiguráciu zadajte v jednom volaní:

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>

Táto funkcia prehľadá koreňový prvok a vytvorí jeho animácie. Opätovné zavolanie glaze() vytvorí ďalšiu inštanciu; nepridá konfiguráciu do existujúcej inštancie.

Explicitný adaptér API je pre GSAP ekvivalentný:

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

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

Pre Motion použite createMotionAdapter({ animate, stagger }) z glazejs/motion. Pokyny na nastavenie a podporované funkcie nájdete v návode pre Motion. V jednej konfigurácii vyberte buď adapter, alebo lib.

Možnosti

Možnosť Predvolená hodnota Účel
lib.gsap.core none GSAP inštancia pre pôvodné nastavenie API.
adapter none Explicitný adaptér GSAP alebo Motion; alternatíva k lib.
element document Koreňový prvok DOM na prehľadanie a sledovanie.
dataAttribute "data-animate" Atribút obsahujúci animačné utility.
className none Predpona triedy pre syntax tried.
breakpoints { default: "(min-width: 1px)" } Pomenované mediálne dopyty.
defaults.tl none Predvolené nastavenia časovej osi.
defaults.element none Predvolené vlastnosti animácie; utility prvku majú prednosť.
presets none Pomenované reťazce opakovane použiteľných animácií.
watch false Sledovanie zmien DOM; true používa oneskorenie 500 ms, alebo zadajte { debounceTime }.

Režim sledovania zaznamenáva pridávanie a odstraňovanie potomkov a zmeny animačných atribútov v rámci koreňového prvku. V režime tried sleduje aj zmeny tried. Relevantná zmena DOM naplánuje opätovné zostavenie s oneskorením. Zmeny vložených animačných štýlov opätovné zostavenie nespúšťajú.

Obnovenie a čistenie

Ponechajte si vrátenú inštanciu na správu životného cyklu:

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

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

refresh() znova vytvorí podľa pôvodnej konfigurácie. destroy() zastaví animácie, odstráni pozorovatele a poslucháče mediálnych dotazov a obnoví pôvodné vložené štýly. Možno ho bezpečne zavolať viackrát. Zničenú inštanciu nemožno znovu spustiť pomocou refresh(); pri opätovnom pripojení vytvorte novú inštanciu.

Návratová hodnota obsahuje aj timelines, breakpoints a vyriešené state. Každá položka časovej osi zaznamenáva časovú os enginu, ID, mediálny dotaz, koreňový prvok, nastavenia a animované prvky. Volania prehrávania špecifické pre daný engine ponechajte v kóde, ktorý pozná adaptér vytvárajúci inštanciu.

Obnovenia a responzívne opätovné zostavenia môžu nahradiť natívne objekty časovej osi. Po opätovnom zostavení si pri ovládaní prehrávania načítajte aktuálnu hodnotu timelines[index].timeline namiesto toho, aby ste si ponechali odkaz na predchádzajúcu natívnu časovú os.

CDN

Verejné vstupné body sú moduly ES a možno ich načítať aj z 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 } } })