Lewati ke konten

Memulai

Instal Glaze dan engine animasi yang Anda gunakan:

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

GSAP dan Motion adalah dependensi peer opsional. Glaze tidak menyertakan kedua engine tersebut.

Inisialisasi sekali

Panggil glaze() setelah elemen Anda berada di DOM. Berikan engine dan semua konfigurasi dalam satu pemanggilan:

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>

Ini memindai root dan membuat animasinya. Memanggil glaze() lagi akan membuat instance lain; konfigurasi tidak ditambahkan ke instance yang sudah ada.

Adapter eksplisit API setara untuk GSAP:

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

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

Untuk Motion, gunakan createMotionAdapter({ animate, stagger }) dari glazejs/motion. Lihat Panduan Motion untuk penyiapan dan fitur yang didukung. Pilih adapter atau lib dalam satu konfigurasi.

Opsi

Opsi Default Tujuan
lib.gsap.core none Instance GSAP untuk penyiapan awal API.
adapter none Adapter eksplisit GSAP atau Motion; alternatif untuk lib.
element document Root DOM yang akan dipindai dan diamati.
dataAttribute "data-animate" Atribut yang berisi utilitas animasi.
className none Prefiks kelas untuk sintaks kelas.
breakpoints { default: "(min-width: 1px)" } Kueri media bernama.
defaults.tl none Pengaturan default timeline.
defaults.element none Properti default animasi; utilitas elemen diutamakan.
presets none String animasi bernama yang dapat digunakan kembali.
watch false Amati perubahan DOM; true menggunakan debounce 500 ms, atau berikan { debounceTime }.

Mode pemantauan mengamati penambahan/penghapusan elemen turunan dan perubahan atribut animasi di dalam root. Dalam mode kelas, perubahan kelas juga diamati. Mutasi DOM yang relevan akan menjadwalkan pembangunan ulang dengan debounce. Perubahan gaya animasi inline tidak memicu pembangunan ulang.

Refresh dan pembersihan

Simpan instance yang dikembalikan untuk pengelolaan siklus hidup:

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

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

refresh() membangun ulang menggunakan konfigurasi asli. destroy() menghentikan animasi, menghapus observer dan listener kueri media, serta memulihkan gaya inline asli. Aman dipanggil lebih dari sekali. Instance yang sudah dihancurkan tidak dapat dimulai ulang dengan refresh(); buat instance baru saat memasang kembali.

Nilai yang dikembalikan juga mencakup timelines, breakpoints, dan state yang telah diresolusikan. Setiap entri timeline mencatat timeline engine, ID, kueri media, elemen root, pengaturan, dan elemen yang dianimasikan. Gunakan pemanggilan pemutaran khusus engine dalam kode yang mengetahui adapter mana yang membuat instance tersebut.

Penyegaran dan pembangunan ulang responsif dapat mengganti objek timeline native. Baca timelines[index].timeline saat ini ketika mengontrol pemutaran setelah pembangunan ulang, alih-alih menyimpan referensi timeline native sebelumnya.

CDN

Titik masuk publik adalah modul ES dan juga dapat dimuat dari CDN ESM:

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