コンテンツへスキップ

セレクター

デフォルトでは、Glazeはdata-animate属性を持つ要素を検索し、その属性の値に基づいてアニメーションを構築します。このページでは、Glazeが読み取る要素を変更する3つのオプション、dataAttribute、className、elementと、アニメーションの対象を別の要素に指定する角括弧セレクターについて説明します。文字列内のユーティリティについては、構文で説明します。

要素の検索方法

glaze()の実行時、およびrefresh()や監視モードで再構築するたびに、ルート内のすべての要素を調べ、設定された属性を持つ要素、またはクラスモードで設定されたプレフィックスを含むクラスを持つ要素を抽出します。ルート要素自体も、該当するものを持っていれば対象になります。要素はドキュメント順で読み取られます。

この方法で見つかった各要素には、それぞれ独自のタイムラインが割り当てられます。ただし、tl要素の内側にある場合、またはtl:<id>でその要素にリンクしている場合は、そのタイムラインに追加されます。グループ化の仕組みについては、タイムラインを参照してください。

カスタム属性

別のdata属性を使います。

JavaScript
glaze({
  lib: { gsap: { core: gsap } },
  dataAttribute: "data-move",
})

これで、Glazeはdata-animateではなくdata-moveを探すようになります:

HTML
<div data-move="from:opacity-0"></div>

このオプションは属性を追加せず、置き換えます。上記の設定では、data-animateを持つ要素は無視されます。ページ上の別のスクリプトがすでにdata-animateを読み取っている場合や、マークアップで属性名をプロジェクトに合わせたい場合に使います。

Glazeのウォッチモードでは、設定された属性を監視するため、要素のdata-moveの値を変更すると再構築が予約されます。

クラスベースの構文

data属性よりクラスを使いたい場合は、クラスモードを有効にします。

JavaScript
glaze({
  lib: { gsap: { core: gsap } },
  className: "animate",
})

これでアニメーションをクラスとして記述できます。

HTML
<div class="animate-from:opacity-0|duration-1"></div>

すでにユーティリティファーストのCSSを使っていて、アニメーションにも似た雰囲気を持たせたい場合に適しています。テンプレートシステムで要素にクラスは追加できても、任意の属性は追加できない場合にも、クラスモードが役立ちます。

Glazeは、接頭辞の後にハイフンが続くクラス(ここではanimate-)をすべて読み取り、その部分を取り除きます。接頭辞のないクラスはそのまま残るため、同じ要素にアニメーションクラスとスタイル用クラスを併用できます。アニメーションは複数のクラスに分けて指定できます。

HTML
<div class="card animate-from:opacity-0 animate-from:y-24"></div>

レスポンシブクラスでは、ブレークポイントを接頭辞の後または前に指定できます。どちらの場合も、lgがブレークポイントに一致するときだけ実行されます。

HTML
<div class="animate-@lg:from:opacity-0"></div>
<div class="@lg:animate-from:opacity-0"></div>

クラスでもプリセットは同じように使えます。たとえばanimate-preset-fadeInです。

クラスモードにしてもデータ属性は無効になりません。両方がある要素では、Glazeがそれらを1つの文字列に連結します。属性値が先で、その後にclass属性内の順序で接頭辞付きクラスが続きます。

HTML
<div
  class="animate-from:opacity-0 animate-@lg:from:y-50"
  data-animate="from:duration-1"
></div>

この要素はどの画面サイズでもopacity: 0から1秒かけてアニメーションし、lgに一致する場合はy: 50からもアニメーションします。文字列が連結されるため、単一の文字列内と同じルールが適用されます。同じプロパティを設定する部分が複数ある場合、後の指定が優先されます。ここでは、クラス値が属性値のxを上書きします。

HTML
<div class="animate-to:x-100" data-animate="to:x-50|y-20"></div>

要素はx: 100およびy: 20へアニメーションします。

クラスモードでwatchを有効にすると、Glazeはclassの変更も監視します。要素にanimate-クラスを追加した場合や、Glazeがすでに読み取っている、またはアニメーションしている要素のクラスを変更した場合は、再構築がスケジュールされます。相対セレクターを含む要素では、子孫要素のクラス変更も再構築の対象になります。セレクターに一致する要素が変わる可能性があるためです。それ以外の要素のクラス変更は対象外です。アニメーション中の要素の祖先も含まれるため、<html>のダークモードクラスや<body>のスクロールロッククラスを切り替えても、実行中のアニメーションには影響しません。クラス変更によって要素が新たにグローバルセレクターに一致しても検知されません。その場合は、後からrefresh()を呼び出してください。

Glazeはデフォルトでdocument全体を検索します。elementを渡すと、コンテナー内の要素だけをアニメーションできます。

JavaScript
glaze({
  lib: { gsap: { core: gsap } },
  element: document.querySelector("#app"),
})

elementにはElementまたはDocumentを指定できます。次の3つを制限します。

  • アニメーション用ユーティリティの検索対象はルートとその子孫のみです。ページ上のほかの場所にある要素は、data-animateを持っていても無視されます。
  • ウォッチモードが監視するのはルート内の変更のみです。
  • destroy()がクリーンアップするのは、このインスタンスが作成したものだけなので、ページのほかの部分のアニメーションは維持されます。

そのため、コンポーネントフレームワークではelementが便利です。マウントされた各コンポーネントについて、コンポーネントのルート要素を使ってインスタンスを1つ作成し、アンマウント時にdestroy()を呼び出します。詳しくは更新とクリーンアップを参照してください。重ならないルートを各インスタンスに割り当ててください。2つのルート内にある要素は、両方のインスタンスによってアニメーションします。

ほかの要素を対象にする

上記のオプションは、Glazeが読み取る要素を決めます。セグメントの先頭に角括弧のセレクターを置くと、アニメーションを適用する要素を指定できます。セレクターがない場合、ユーティリティを持つ要素がアニメーションの対象になります。

相対セレクター

&で始まるセレクターは、その要素を基準に解決され、&はその要素を表します。querySelectorAllで検索するため、複数の要素に一致する場合があります。

HTML
<ul data-animate="[&>li]:from:opacity-0|y-20|stagger-0.1">
  <li>One</li>
  <li>Two</li>
  <li>Three</li>
</ul>

[&>li]は直接のli子要素に一致します。staggerの値は、それぞれの開始時刻を0.1秒ずつずらします。子要素ごとに属性を追加せずに、1つの要素からリスト、グリッド、または子要素のグループのアニメーションを制御する場合に使います。

スペースはアンダースコアで記述します。[&_p]は& pとなり、要素内のすべての深さにあるpに一致します。

HTML
<article data-animate="[&_p]:from:opacity-0|stagger-0.2">
  <p>First paragraph</p>
  <div><p>Nested paragraph</p></div>
</article>

セレクター内のアンダースコアはすべてスペースに変換されるため、アンダースコアを含むクラス名にはこの方法で一致させられません。

[&]だけの場合は、要素自体を指します。主に値として使われます。 たとえば、scrollTrigger.trigger-[&]はScrollTriggerデフォルトおよびタイムラインデフォルトで使われます。

グローバルセレクター

&を含まないセレクターは、文字列としてアニメーションエンジンに渡されます。GSAPとMotionは、要素やelementルートではなく、ドキュメント全体を対象に解決します。

HTML
<h2 data-animate="[.badge]:from:opacity-0|scale-0.5|duration-0.3">Inbox</h2>
<span class="badge">3</span>

これにより、ページ上の場所を問わず、すべての.badgeがアニメーションします。再利用可能なコンポーネント内では相対セレクターを使うことをおすすめします。グローバルセレクターはページ上の別の場所にある同じコンポーネントの複製にも一致するためです。

制限事項

各要素のターゲットは1つです。複数のセグメントにセレクターがある場合、最後のセレクターがその要素のすべての状態に適用されます。ここではfromとtoの両方がpに適用され、h1には適用されません。

HTML
<div data-animate="[&>h1]:from:opacity-0 [&>p]:to:x-20">
  <h1>Title</h1>
  <p>Text</p>
</div>

2つのグループを別々にアニメーションさせるには、ユーティリティを子要素自体に指定するか、タイムラインにまとめてください。

セレクターは最初の]で終わるため、[&>[data-item]]のような属性セレクターなど、角括弧を含むセレクターはサポートされません。代わりにクラスまたは要素セレクターを使ってください。

セレクターとブレークポイントの組み合わせ順序は構文の説明のとおりです。たとえば@lg:[&>div]:from:opacity-0です。