Към съдържанието

Първи стъпки

Инсталирайте Glaze и енджина за анимации, който използвате:

Обвивка
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

GSAP и Motion са незадължителни peer зависимости. Glaze не включва нито един от двата енджина.

Еднократна инициализация

Извикайте glaze(), след като елементите ви са в DOM. Подайте енджина и цялата конфигурация с едно извикване:

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>

Това сканира основния елемент и създава анимациите му. Повторното извикване на glaze() създава друг екземпляр; то не добавя конфигурация към съществуващ.

Изрично зададеният адаптер 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 няма Изрично зададен адаптер GSAP или Motion; алтернатива на lib.
element document Основен DOM елемент за сканиране и наблюдение.
dataAttribute "data-animate" Атрибут, съдържащ помощните класове за анимация.
className няма Префикс на класовете за синтаксиса на класове.
breakpoints { default: "(min-width: 1px)" } Именувани медийни заявки.
defaults.tl няма Настройки на времевата линия по подразбиране.
defaults.element няма Свойства на анимацията по подразбиране; помощните класове на елемента имат предимство.
presets няма Именувани низове за анимация, които могат да се използват повторно.
watch false Наблюдение на промените в DOM; true използва изчакване от 500 ms, или подайте { debounceTime }.

Режимът на наблюдение следи добавянето и премахването на дъщерни елементи и промените в атрибутите за анимация в рамките на основния елемент. В режим на класове той следи и промените в класовете. Всяка съществена промяна в DOM планира повторно изграждане със закъснение. Промените във вградените стилове за анимация не задействат повторно изграждане.

Обновяване и почистване

Запазете върнатия екземпляр за управление на жизнения цикъл:

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

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

refresh() изгражда отново с първоначалната конфигурация. destroy() спира анимациите, премахва наблюдателите и слушателите за медийни заявки и възстановява първоначалните вградени стилове. Безопасно е да се извика повече от веднъж. Унищожен екземпляр не може да бъде стартиран отново с refresh(); при ново монтиране създайте нов екземпляр.

Върнатата стойност включва също timelines, breakpoints и разрешената state. Всеки запис във времевата линия съдържа времевата линия на енджина, ID, медийната заявка, кореновия елемент, настройките и анимираните елементи. Извикванията за възпроизвеждане, специфични за енджина, трябва да бъдат в код, който знае кой адаптер е създал екземпляра.

Опресняването и адаптивните повторни изграждания могат да заменят нативните обекти на времевата линия. След повторно изграждане прочетете текущата timelines[index].timeline, когато управлявате възпроизвеждането, вместо да използвате запазена препратка към предишна нативна времева линия.

CDN

Публичните входни точки са ES модули и могат да бъдат заредени и от 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 } } })