コンテンツへスキップ

はじめに

Glazeと、使用するアニメーションエンジンをインストールします。

シェル
pnpm add glazejs gsap
# Or choose Motion:
pnpm add glazejs motion

GSAPとMotionは、任意のピア依存関係です。Glazeにはどちらのエンジンもバンドルされていません。

一度だけ初期化する

要素がDOMに追加された後にglaze()を呼び出します。エンジンとすべての設定を1回の呼び出しで指定します。

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の場合は、glazejs/motionからcreateMotionAdapter({ animate, stagger })を使用します。セットアップ方法と対応機能については、Motionガイドをご覧ください。1つの設定で、adapterまたはlibのいずれかを選択します。

オプション

オプション デフォルト 用途
lib.gsap.core なし 元の設定APIに使用するGSAPインスタンス。
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も含まれます。各タイムラインエントリーには、エンジンのタイムライン、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 } } })