Pular para o conteúdo

Primeiros passos

Instale Glaze e o mecanismo de animação que você usa:

Shell
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

GSAP e Motion são dependências opcionais de peer. Glaze não inclui nenhum dos dois mecanismos.

Inicialize uma vez

Chame glaze() depois que seus elementos estiverem no DOM. Forneça o mecanismo e toda a configuração em uma única chamada:

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>

Isso examina a raiz e cria suas animações. Chamar glaze() novamente cria outra instância; não adiciona configuração a uma instância existente.

O adaptador explícito API é equivalente para GSAP:

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

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

Para o Motion, use createMotionAdapter({ animate, stagger }) de glazejs/motion. Consulte o guia do Motion para ver a configuração e os recursos compatíveis. Escolha adapter ou lib em uma única configuração.

Opções

Opção Padrão Finalidade
lib.gsap.core nenhum Instância GSAP para a configuração original API.
adapter nenhum Adaptador explícito GSAP ou Motion; alternativa a lib.
element document Raiz do DOM a examinar e observar.
dataAttribute "data-animate" Atributo que contém os utilitários de animação.
className nenhum Prefixo de classe para a sintaxe de classes.
breakpoints { default: "(min-width: 1px)" } Consultas de mídia nomeadas.
defaults.tl nenhum Configurações padrão de timeline.
defaults.element nenhum Propriedades padrão de animação; os utilitários do elemento têm precedência.
presets nenhum Strings de animação nomeadas e reutilizáveis.
watch false Observar alterações no DOM; true usa um debounce de 500 ms, ou passe { debounceTime }.

O modo de observação detecta adições e remoções de filhos, além de alterações nos atributos de animação dentro da raiz. No modo de classes, também detecta alterações nas classes. Uma mutação relevante no DOM agenda uma reconstrução com debounce. Alterações nos estilos de animação inline não acionam reconstruções.

Atualização e limpeza

Mantenha a instância retornada para gerenciar o ciclo de vida:

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

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

refresh() reconstrói usando a configuração original. destroy() interrompe as animações, remove observadores e listeners de consultas de mídia e restaura os estilos inline originais. É seguro chamar mais de uma vez. Uma instância destruída não pode ser reiniciada com refresh(); crie uma nova instância ao montar novamente.

O valor de retorno também inclui timelines, breakpoints e state resolvido. Cada entrada da linha do tempo registra a linha do tempo do mecanismo, o ID, a consulta de mídia, o elemento raiz, as configurações e os elementos animados. Mantenha as chamadas de reprodução específicas do mecanismo em código que saiba qual adaptador criou a instância.

Atualizações e reconstruções responsivas podem substituir os objetos nativos da linha do tempo. Leia o timelines[index].timeline atual ao controlar a reprodução após uma reconstrução, em vez de manter uma referência anterior à linha do tempo nativa.

CDN

Os pontos de entrada públicos são módulos ES e também podem ser carregados de um CDN ESM:

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 } } })