Přejít k obsahu

Začínáme

Nainstalujte Glaze a animační engine, který používáte:

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

GSAP a Motion jsou volitelné peer dependencies. Glaze neobsahuje ani jeden z těchto enginů.

Jednorázová inicializace

Po vložení prvků do DOM zavolejte glaze(). Engine i veškerou konfiguraci zadejte v jediném volání:

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ím se prohledá kořenový prvek a vytvoří se jeho animace. Opakované zavolání glaze() vytvoří další instanci; nepřidá konfiguraci do té stávající.

Explicitní adaptér API je pro GSAP ekvivalentní:

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

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

Pro Motion použijte createMotionAdapter({ animate, stagger }) z glazejs/motion. Pokyny k nastavení a podporovaným funkcím najdete v Průvodci Motion. V jediné konfiguraci zvolte buď adapter, nebo lib.

Možnosti

Možnost Výchozí hodnota Účel
lib.gsap.core none GSAP instance pro původní nastavení API.
adapter none Explicitní GSAP nebo adaptér Motion; alternativa k lib.
element document Kořenový element DOM, který se má prohledat a sledovat.
dataAttribute "data-animate" Atribut obsahující animační utility.
className none Prefix tříd pro syntaxi tříd.
breakpoints { default: "(min-width: 1px)" } Pojmenované mediální dotazy.
defaults.tl none Výchozí nastavení časové osy.
defaults.element none Výchozí vlastnosti animace; utility prvků mají přednost.
presets none Pojmenované opakovaně použitelné řetězce animací.
watch false Sledování změn DOM; true používá prodlevu 500 ms, nebo předejte { debounceTime }.

Režim sledování zaznamenává přidávání a odebírání potomků a změny animačních atributů v kořenovém prvku. V režimu tříd sleduje také změny tříd. Relevantní změna DOM naplánuje opětovné sestavení s prodlevou. Změny vložených animačních stylů opětovné sestavení nespustí.

Obnovení a čištění

Uchovávejte vrácenou instanci pro 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() znovu vytvoří podle původní konfigurace. destroy() zastaví animace, odebere pozorovatele a posluchače mediálních dotazů a obnoví původní vložené styly. Lze jej bezpečně volat opakovaně. Zničenou instanci nelze znovu spustit pomocí refresh(); při opětovném připojení vytvořte novou instanci.

Návratová hodnota obsahuje také timelines, breakpoints a vyřešené state. Každá položka časové osy zaznamenává časovou osu enginu, ID, mediální dotaz, kořenový prvek, nastavení a animované prvky. Volání přehrávání specifická pro daný engine používejte v kódu, který ví, který adaptér instanci vytvořil.

Obnovení a opětovné sestavení při změně velikosti mohou nahradit nativní objekty časové osy. Při ovládání přehrávání po opětovném sestavení načtěte aktuální timelines[index].timeline místo uchovávání odkazu na předchozí nativní časovou osu.

CDN

Veřejné vstupní body jsou moduly ES a lze je načíst také 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 } } })