Μετάβαση στο περιεχόμενο

Ξεκινώντας

Εγκαταστήστε το Glaze και το engine animation που χρησιμοποιείτε:

Κέλυφος
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

Τα GSAP και Motion είναι προαιρετικές peer dependencies. Το Glaze δεν ενσωματώνει κανένα από τα δύο engine.

Αρχικοποίηση μία φορά

Καλέστε το glaze() αφού τα στοιχεία σας προστεθούν στο DOM. Δώστε το engine και όλη τη διαμόρφωση σε μία κλήση:

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>

Αυτό σαρώνει το root και δημιουργεί τα animations του. Αν καλέσετε ξανά το glaze(), δημιουργείται νέα παρουσία· δεν προστίθεται διαμόρφωση σε υπάρχουσα.

Ο ρητός adapter API είναι ισοδύναμος για το GSAP:

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

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

Για το Motion, χρησιμοποιήστε το createMotionAdapter({ animate, stagger }) από το glazejs/motion. Δείτε τον οδηγό Motion για τη ρύθμιση και τις υποστηριζόμενες δυνατότητες. Επιλέξτε είτε το adapter είτε το lib σε μία ενιαία διαμόρφωση.

Επιλογές

Επιλογή Προεπιλογή Σκοπός
lib.gsap.core καμία Παρουσία GSAP για την αρχική ρύθμιση API.
adapter καμία Ρητός adapter GSAP ή Motion· εναλλακτική του lib.
element document Root DOM προς σάρωση και παρακολούθηση.
dataAttribute "data-animate" Χαρακτηριστικό που περιέχει utilities animation.
className καμία Πρόθεμα κλάσης για σύνταξη class.
breakpoints { default: "(min-width: 1px)" } Επώνυμα media query.
defaults.tl καμία Προεπιλεγμένες ρυθμίσεις timeline.
defaults.element καμία Προεπιλεγμένες ιδιότητες animation· τα utilities του στοιχείου υπερισχύουν.
presets καμία Επώνυμες, επαναχρησιμοποιήσιμες συμβολοσειρές animation.
watch false Παρακολούθηση αλλαγών DOM· το true χρησιμοποιεί debounce 500 ms ή δώστε το { debounceTime }.

Η λειτουργία παρακολούθησης εντοπίζει προσθήκες και αφαιρέσεις θυγατρικών στοιχείων, καθώς και αλλαγές στα χαρακτηριστικά animation μέσα στο root. Σε λειτουργία class εντοπίζει επίσης αλλαγές στις κλάσεις. Κάθε σχετική μεταβολή DOM προγραμματίζει αναδημιουργία με debounce. Οι αλλαγές στα inline styles animation δεν προκαλούν αναδημιουργία.

Ανανέωση και καθαρισμός

Κρατήστε την παρουσία που επιστρέφεται για τη διαχείριση του κύκλου ζωής:

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

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

Το refresh() δημιουργεί ξανά τις κινούμενες εικόνες με βάση την αρχική διαμόρφωση. Το destroy() σταματά τις κινούμενες εικόνες, αφαιρεί τους παρατηρητές και τους ακροατές συμβάντων ερωτημάτων πολυμέσων και επαναφέρει τα αρχικά ενσωματωμένα στυλ. Μπορείτε να το καλέσετε με ασφάλεια περισσότερες από μία φορές. Ένα instance που έχει καταστραφεί δεν μπορεί να επανεκκινηθεί με το refresh()· δημιουργήστε ένα νέο instance κατά την εκ νέου προσάρτηση.

Η τιμή επιστροφής περιλαμβάνει επίσης τα timelines, breakpoints και το επιλυμένο state. Κάθε εγγραφή χρονογραμμής καταγράφει τη χρονογραμμή της μηχανής, το ID, το ερώτημα πολυμέσων, το ριζικό στοιχείο, τις ρυθμίσεις και τα στοιχεία στα οποία εφαρμόζεται η κινούμενη εικόνα. Διατηρήστε τις κλήσεις αναπαραγωγής που αφορούν συγκεκριμένη μηχανή σε κώδικα που γνωρίζει ποιος adapter δημιούργησε το instance.

Οι ανανεώσεις και οι ανακατασκευές για προσαρμογή στις διαστάσεις της οθόνης μπορεί να αντικαταστήσουν τα εγγενή αντικείμενα χρονογραμμής. Κατά τον έλεγχο της αναπαραγωγής μετά από ανακατασκευή, διαβάστε το τρέχον timelines[index].timeline αντί να διατηρείτε μια παλαιότερη αναφορά σε εγγενή χρονογραμμή.

CDN

Τα δημόσια σημεία εισόδου είναι ES modules και μπορούν επίσης να φορτωθούν από ένα 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 } } })