Перейти до вмісту

Початок роботи

Установіть Glaze і рушій анімації, який використовуєте:

Командна оболонка
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

GSAP і Motion — необов’язкові однорангові залежності. 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 мс перед обробкою, або передайте { 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. Кожен запис часової шкали містить часову шкалу рушія, ідентифікатор, медіазапит, кореневий елемент, налаштування й анімовані елементи. Виклики керування відтворенням, специфічні для рушія, розміщуйте в коді, який знає, який адаптер створив екземпляр.

Під час оновлення та адаптивної перебудови об’єкти нативної часової шкали можуть замінюватися. Після перебудови, керуючи відтворенням, отримуйте поточний 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 } } })