Начало работы
Установите Glaze и используемый вами движок анимации:
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion
GSAP и Motion являются необязательными одноранговыми зависимостями. Glaze не включает ни один из движков.
Инициализация
Вызовите glaze() после добавления элементов в DOM. Передайте движок и всю конфигурацию одним вызовом:
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>
Эта операция сканирует корневой элемент и создает его анимации. Повторный вызов glaze() создает еще один экземпляр, а не добавляет конфигурацию к существующему.
Явный адаптер API эквивалентен для GSAP:
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 |
none | Экземпляр GSAP для первоначальной настройки API. |
adapter |
none | Явный адаптер GSAP или Motion; альтернатива lib. |
element |
document |
Корневой элемент DOM для сканирования и наблюдения. |
dataAttribute |
"data-animate" |
Атрибут, содержащий утилиты анимации. |
className |
none | Префикс классов для синтаксиса классов. |
breakpoints |
{ default: "(min-width: 1px)" } |
Именованные медиазапросы. |
defaults.tl |
none | Настройки таймлайнов по умолчанию. |
defaults.element |
none | Свойства анимации по умолчанию; утилиты элемента имеют приоритет. |
presets |
none | Именованные повторно используемые строки анимации. |
watch |
false |
Наблюдать за изменениями DOM; true использует задержку 500 мс или передайте { debounceTime }. |
Режим наблюдения отслеживает добавление и удаление дочерних элементов, а также изменения атрибутов анимации внутри корневого элемента. В режиме классов он также отслеживает изменения классов. При изменении DOM, влияющем на анимацию, перестроение запускается с задержкой. Изменения встроенных стилей анимации не запускают перестроение.
Обновление и очистка
Сохраните возвращенный экземпляр для управления жизненным циклом:
// 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:
import glaze from "https://esm.sh/glazejs"
import { gsap } from "https://esm.sh/gsap@3.15.0"
const animations = glaze({ lib: { gsap: { core: gsap } } })