Başlarken
Glaze ile kullandığınız animasyon motorunu yükleyin:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP ve Motion isteğe bağlı eş bağımlılıklardır. Glaze bu motorlardan hiçbirini paketine dahil etmez.
Bir kez başlatın
Öğeleriniz DOM'a eklendikten sonra glaze() çağrısını yapın. Motoru ve tüm yapılandırmayı tek bir çağrıda sağlayın:
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>
Bu işlem, kökü tarar ve animasyonlarını oluşturur. glaze() çağrısını yeniden yapmak başka bir örnek oluşturur; mevcut örneğe yapılandırma eklemez.
Açıkça belirtilen API adaptörü, GSAP için eşdeğerdir:
import glaze from "glazejs"
import { createGsapAdapter } from "glazejs/gsap"
import { gsap } from "gsap"
const animations = glaze({ adapter: createGsapAdapter(gsap) })
Motion için glazejs/motion içinden createMotionAdapter({ animate, stagger }) kullanın. Kurulum ve desteklenen özellikler için Motion kılavuzuna bakın. Tek bir yapılandırmada adapter veya lib seçin.
Seçenekler
| Seçenek | Varsayılan | Amaç |
|---|---|---|
lib.gsap.core |
yok | İlk kurulum için GSAP örneği API. |
adapter |
yok | Açıkça belirtilen GSAP veya Motion adaptörü; lib yerine kullanılır. |
element |
document |
Taranacak ve izlenecek DOM kökü. |
dataAttribute |
"data-animate" |
Animasyon yardımcı sınıflarını içeren öznitelik. |
className |
yok | sınıf sözdizimi için sınıf öneki. |
breakpoints |
{ default: "(min-width: 1px)" } |
Adlandırılmış medya sorguları. |
defaults.tl |
yok | Varsayılan zaman çizelgesi ayarları. |
defaults.element |
yok | Varsayılan animasyon özellikleri; öğe yardımcı sınıfları önceliklidir. |
presets |
yok | Adlandırılmış, yeniden kullanılabilir animasyon dizgeleri. |
watch |
false |
DOM değişikliklerini izle; true, 500 ms gecikmeli çalışır veya { debounceTime } değerini geçirin. |
İzleme modu, kök içindeki alt öğe ekleme ve kaldırma işlemlerini ve animasyon özniteliğindeki değişiklikleri izler. Sınıf modunda sınıf değişikliklerini de izler. İlgili bir DOM değişikliği, gecikmeli bir yeniden oluşturma işlemi planlar. Satır içi animasyon stili değişiklikleri yeniden oluşturmayı tetiklemez.
Yenileme ve temizleme
Yaşam döngüsü yönetimi için döndürülen örneği saklayın:
// Rescan after rendering new elements when watch is disabled.
animations.refresh()
// On component unmount or page teardown:
animations.destroy()
refresh() özgün yapılandırmayı kullanarak yeniden oluşturur. destroy() animasyonları durdurur, gözlemcileri ve medya sorgusu dinleyicilerini kaldırır, özgün satır içi stilleri geri yükler. Birden fazla kez çağrılması güvenlidir. Yok edilmiş bir örnek refresh() ile yeniden başlatılamaz; yeniden bağlarken yeni bir örnek oluşturun.
Dönüş değeri ayrıca timelines, breakpoints ve çözümlenmiş state değerini içerir. Her zaman çizelgesi girdisi motorun zaman çizelgesini, kimliğini, medya sorgusunu, kök öğeyi, ayarları ve animasyon uygulanan öğeleri kaydeder. Motora özgü oynatma çağrılarını, örneği hangi adaptörün oluşturduğunu bilen kodda tutun.
Yenilemeler ve duyarlı yeniden oluşturmalar yerel zaman çizelgesi nesnelerini değiştirebilir. Yeniden oluşturmadan sonra oynatmayı denetlerken önceki yerel zaman çizelgesi başvurusunu saklamak yerine geçerli timelines[index].timeline değerini okuyun.
CDN
Genel giriş noktaları ES modülleridir ve bir ESM CDN üzerinden de yüklenebilir:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })