(Article)Est. 2023 — Tokyo, JP

BLOG

← Back to Blog
Next.js

Next.js App RouterでGSAPを使う:useGSAPとtemplate.tsxでスクロール演出を組む

「NEXT BASE」では、最初のローディング、1 文字ずつ下から現れる見出し、縦スクロールに合わせて横に流れるブログ欄、画像のパララックスなどを GSAP と ScrollTrigger で動かしています。App Router に移行したのに合わせて、以前の gsap.context と自作の useIsomorphicLayoutEffect の組み合わせを、公式の @gsap/react の useGSAP に置き換えました。

リポジトリ:Nextjs-TypeScript-MicroCMS-Site / デモ:https://nextbase-gsap.vercel.app/

useGSAP に置き換えた理由

React で GSAP を使うときに気をつけるのは、アンマウントやページ遷移のときにアニメーションと ScrollTrigger を確実に片付けることです。以前は useLayoutEffect(SSR では useEffect)の中で gsap.context を作り、戻り値で ctx.revert() を呼んでいました。useGSAP はこれを 1 つのフックでやってくれます。

  • フックの中で作ったアニメーションと ScrollTrigger は、アンマウント時に自動で revert() される
  • scope に要素を渡すと、'.hero__img' のようなセレクタがその要素の中だけで探される
  • SSR でも警告が出ないよう、内部でレイアウトエフェクトと通常のエフェクトを使い分けてくれる

GSAP の登録は lib/gsap.ts で 1 回だけ

プラグインの登録や設定はブラウザで 1 回だけ行えばよいので、1 つのファイルにまとめ、各コンポーネントはここから import します。スマホではアドレスバーが伸び縮みするたびに画面の高さが変わり、ピン留めの位置が計算し直されてガタつくので、ignoreMobileResize で防いでいます。

// lib/gsap.ts
import { gsap } from 'gsap'
import { ScrollTrigger } from 'gsap/ScrollTrigger'
import { useGSAP } from '@gsap/react'

if (typeof window !== 'undefined') {
  gsap.registerPlugin(ScrollTrigger, useGSAP)
  // スマホのアドレスバー伸縮でピン位置が再計算されてガタつくのを防ぐ
  ScrollTrigger.config({ ignoreMobileResize: true })
}

export const prefersReducedMotion = () =>
  typeof window !== 'undefined' && window.matchMedia('(prefers-reduced-motion: reduce)').matches

export { gsap, ScrollTrigger, useGSAP }

ページは Server Component のまま、動きだけ Client Component に

App Router では、ページは Server Component として microCMS のデータを取得します。GSAP はブラウザで動くので 'use client' が必要ですが、ページ全体を Client Component にすると、データの取得までブラウザ側に寄ってしまいます。そこで、動きを担当する HomeMotion を Client Component にし、ページの中身を children として包む形にしました。children はサーバーで描画されたまま渡るので、データの取得はサーバーに残せます。

// app/page.tsx(Server Component)
export default async function HomePage() {
  const posts = await getBlogs()
  return (
    <HomeMotion>
      <section className="hero">...</section>
      <section className="blog" id="blog">...</section>
    </HomeMotion>
  )
}
// components/home/HomeMotion.tsx
'use client'

export default function HomeMotion({ children }: { children: ReactNode }) {
  const root = useRef<HTMLDivElement>(null)

  useGSAP(
    () => {
      if (prefersReducedMotion()) return
      gsap.to('.hero__img', {
        yPercent: -10,
        ease: 'none',
        scrollTrigger: { trigger: '.hero', start: 'top top', end: 'bottom top', scrub: true },
      })
      // ...
    },
    { scope: root }
  )

  return <div ref={root}>{children}</div>
}

template.tsx でページごとに作り直す

全ページ共通の演出(見出しの文字アニメーション、data-reveal の要素の表示、マグネットボタン)は PageMotion にまとめ、app/template.tsx から使っています。layout.tsx はページを移動しても作り直されませんが、template.tsx はページを移動するたびに作り直されます。そのため、移動先のページの要素に対して ScrollTrigger を一から設定し直せます。ヘッダーのように移動しても残したいものは layout.tsx に置いています。

// app/template.tsx
/** template はページ遷移ごとに作り直されるため、スクロール演出をページ単位で初期化できる */
export default function Template({ children }: { children: React.ReactNode }) {
  return (
    <PageMotion>
      <main id="top">{children}</main>
      <Footer />
    </PageMotion>
  )
}

見出しは 1 文字ずつ span に分ける

見出しを 1 文字ずつ動かすために、文字を span に分ける SplitText コンポーネントを作りました。状態を持たないので Server Component のままで動きます。分けた文字はスクリーンリーダーには 1 文字ずつ読まれてしまうので、aria-hidden を付け、親の aria-label で元の文字列を読ませています。

// components/SplitText.tsx
export default function SplitText({ text, as: Tag = 'span', className }: Props) {
  return (
    <Tag className={className} aria-label={text}>
      {[...text].map((c, i) => (
        <span className="char" aria-hidden="true" key={i}>
          {c === ' ' ? '\u00a0' : c}
        </span>
      ))}
    </Tag>
  )
}
// components/motion/PageMotion.tsx(抜粋)
gsap.utils.toArray<HTMLElement>('.sec-head').forEach((head) => {
  gsap.timeline({ scrollTrigger: { trigger: head, start: 'top 80%' } }).from(
    head.querySelectorAll('.sec-head__title .char'),
    { yPercent: 100, autoAlpha: 0, duration: 1, stagger: 0.05, ease: 'expo.out' }
  )
})

ローディングは最初の訪問時だけ

トップに戻るたびにローディングが流れると煩わしいので、最初の 1 回だけ再生します。モジュールの一番外側の変数はページを移動しても残るので、「もう再生したか」をそこに覚えておきます。開発時の StrictMode ではエフェクトが 2 回実行されるため、初回描画のときの判定を useRef に取っておき、2 回目の実行でも同じ判定を使います。

// ローダーは最初の訪問時だけ再生(クライアント遷移で戻ってきたときは省略)
let introPlayed = false

export default function HomeMotion({ children }: { children: ReactNode }) {
  const [showLoader] = useState(() => !introPlayed)
  // StrictMode / Activity で effect が再実行されても、初回描画時の判定を使う
  const playLoaderRef = useRef(showLoader)

  useGSAP(() => {
    const playLoader = playLoaderRef.current && !prefersReducedMotion()
    introPlayed = true
    playLoaderRef.current = false
    // ...
  }, { scope: root })
}

縦スクロールで横に流れるブログ欄

ブログ欄はセクションを画面に固定(pin)し、縦にスクロールした分だけカードの列を横に動かしています。動かす距離は「列の幅 − 画面の幅」です。画面サイズが変わったときに計算し直せるよう、値を関数で渡し、invalidateOnRefresh を付けています。各カードの文字は、横の動きを基準にした containerAnimation で、画面に入ったときに浮かび上がらせます。

const getDist = () => Math.max(0, track.scrollWidth - window.innerWidth)
const tween = gsap.to(track, {
  x: () => -getDist(),
  ease: 'none',
  scrollTrigger: {
    trigger: '.blog__pin',
    start: 'top top',
    end: () => '+=' + getDist(),
    pin: true,
    scrub: 1,
    invalidateOnRefresh: true,
    onUpdate: (self) => gsap.set('.blog__bar i', { scaleX: self.progress }),
  },
})

gsap.utils.toArray<HTMLElement>('.blog__track .post').forEach((card) => {
  gsap.from(card.querySelector('.post__body'), {
    y: 40,
    autoAlpha: 0,
    scrollTrigger: { trigger: card, containerAnimation: tween, start: 'left 85%' },
  })
})

イベントで動かすアニメーションは contextSafe で包む

ボタンがカーソルに吸い寄せられるマグネットボタンのように、イベントの中で作るアニメーションは、そのままでは useGSAP の片付けの対象になりません。contextSafe で包むと、後から作ったアニメーションも片付けの対象に入ります。イベントリスナー自体は、自分で外します。

useGSAP((_ctx, contextSafe) => {
  const cleanups = gsap.utils.toArray<HTMLElement>('.btn').map((el) => {
    const onMove = contextSafe!((e: PointerEvent) => {
      const r = el.getBoundingClientRect()
      gsap.to(el, {
        x: (e.clientX - r.left - r.width / 2) * 0.25,
        y: (e.clientY - r.top - r.height / 2) * 0.35,
        duration: 0.4,
      })
    })
    el.addEventListener('pointermove', onMove)
    return () => el.removeEventListener('pointermove', onMove)
  })
  return () => cleanups.forEach((fn) => fn())
}, { scope: root })

高さが変わったら ScrollTrigger を計算し直す

ScrollTrigger は、設定した時点の要素の位置をもとに発火位置を計算します。画像の読み込みや記事の絞り込みでページの高さが変わると、発火位置がずれて、下のほうの要素がいつまでも表示されないことがあります。そこで、フォントの読み込み完了や ResizeObserver で高さの変化を検知したときに、ScrollTrigger.refresh() を呼んでいます。

動きを減らす設定と、JavaScript が無い環境

アニメーションで後から表示する要素は、最初は隠しておく必要があります。ただ、CSS で常に隠すと、JavaScript が無い環境や動きを減らす設定の人には何も表示されません。そこで layout.tsx の <head> で小さなスクリプトを実行し、動きを減らす設定でないときだけ html に js-ready クラスを付けています。CSS では .js-ready が付いているときだけ要素を隠します。

// app/layout.tsx
const jsReady = `if(!matchMedia('(prefers-reduced-motion: reduce)').matches)document.documentElement.classList.add('js-ready')`

<head>
  <script dangerouslySetInnerHTML={{ __html: jsReady }} />
  <noscript>
    <style>{'.loader{display:none}'}</style>
  </noscript>
</head>

まとめ

  • useGSAP を使えば、片付け(revert)とセレクタの範囲指定を任せられる
  • ページは Server Component のまま、動きだけを Client Component で包む
  • ページごとに作り直したい演出は template.tsx に置く
  • イベントの中のアニメーションは contextSafe で包む
  • ページの高さが変わったら ScrollTrigger.refresh()
  • 隠す CSS は、動きを出せるときだけ効かせる