旧ブログ(ISSEN)から移行しました

【GSAP】初学者向け!GSAPで作るハンバーガーメニュー

【GSAP】初学者向け!GSAPで作るハンバーガーメニュー

杉田侑祐
杉田侑祐7分で読めます

はじめに

この記事の概要

こんにちは、株式会社TOKOSのスギタです!
今回はGreenSock社のGreenSock Animation Platform(GSAP)を使い、ハンバーガーメニューを実装していきたいと思います。
GSAPの基本的な使い方は下記の記事を参考にしてください!

【初学者向け】GSAPでテキストアニメーションをやってみた!!

この記事では、GreenSock社が開発したGreenSock Animation Platform(GSAP)を使いテキストアニメーションを学ぶことができます。 基本的な使い方から学び、実際にテキストアニメーションを実装する方法を紹介しています。

対象読者

  • Web制作でアニメーションの実装をしたい方

今回の完成予定

今回はGSAPを用いてハンバーガーメニューを実装してみたいと思います。
やはりGSAPを使うと動きのあるハンバーガーメニューを簡単に実装できるので、オススメです!
今回はHTML&CSSからJavaScriptまで手順を分け解説していきたいと思います。

環境

動作確認環境はChromeバージョン113です。
今回はリセットCSSを使用しています。
normalize.cssです。
環境によっては多少スタイルが崩れる可能性があるので注意してください。

コードの紹介

HTML&CSSの記述

HTML
<body>
  <header class="nav">
    <div class="nav-bar">
      <h1 class="logo">TOKOS.inc</h1>
      <span class="open">MENU</span>
    </div>
  </header>
  <main class="menu">
    <span class="close">CLOSE</span>
    <div class="menu-container">
      <ul class="nav-list">
        <li class="nav-link"><a href="/">01.HOME</a></li>
        <li class="nav-link"><a href="/">02.SERVICE</a></li>
        <li class="nav-link"><a href="/">03.ABOUT</a></li>
      </ul>
    </div>
  </main>
</body>
CSS
body {
  font-family: "Times New Roman", Times, serif;
}
 
.nav {
  background-color: #333;
  padding: 24px 16px;
  box-shadow: 0px 2px 4px rgba(0, 0, 0, 0.4);
}
 
.nav-bar {
  display: flex;
  justify-content: space-between;
  align-items: center;
  color: #fff;
  max-width: 1200px;
  margin: auto;
}
 
.logo {
  font-size: 24px;
  font-weight: 600;
}
 
.open {
  cursor: pointer;
}
 
.menu {
  background-color: #000;
  color: #fff;
  width: 100%;
  height: 100vh;
}
 
.close {
  position: absolute;
  top: 24px;
  right: 32px;
  font-size: 24px;
  cursor: pointer;
}
 
.menu-container {
  max-width: 1200px;
  margin: auto;
  display: flex;
  align-items: center;
  height: 100%;
  font-size: 40px;
}
 
.nav-link {
  letter-spacing: 0.2rem;
}

ヘッダーと表示させたいメニューのスタイルはお好きなようにしてください!

下記のように表示されていればOKです!

ここからメニュー表示前の状態にしたいので下記プロパティを追加してメニューを画面外に待機させます!

CSS
.menu {
  background-color: #000;
  color: #fff;
  width: 100%;
  height: 100vh;
  position: fixed;
  top: -100%;
}

今回は上から下へメニューを表示したいのでtop: -100%;で画面上部に待機させています!
これで表示させたいメニュー部分は画面外に消えたと思います。
ここからJavaScriptでアニメーションを追加していきたいと思います!

Clickイベントの記述

ここからJavaScriptの記述に入ります。

まずは、今回クリックして表示、非表示を実現するために、ボタン部分の要素の取得をして、あらかじめ変数にしておきます。

JavaScript
const isMenuOpen = document.querySelector(".open")
const isMenuClose = document.querySelector(".close")

次にクリック時にイベントを発火させます。
まずはクリックしたときにコンソールで確認していきます!

JavaScript
isMenuOpen.addEventListener("click", () => {
  console.log("Openボタンをクリックしました!")
})

これで、クリックした際のイベントの発火を確認できました!
あとはGSAPでアニメーションを定義してクリックした際にアニメーションを発火させてやれば良さそうです!

GSAPの導入

GSAPを利用するには、公式HPからダウンロードするか、CDNでも提供されているので公式ドキュメントを参照してください。
今回はCDNを利用していきたいと思います。

Homepage

Supported by Webflow. Animate Anything - A wildly robust JavaScript animation library built for professionals.

greensock.com

GSAPでアニメーションの記述

ここからアニメーションの記述に入ります。
メニューを上から下に表示してから、テキストリンクを表示したいので、Timelineを使ってアニメーションを繋げていきたいと思います。

JavaScript
const tl = gsap.timeline()
 
tl.fromTo(
  //メニューを上から下へ表示
  ".menu",
  {
    autoAlpha: 0,
  },
  {
    autoAlpha: 1,
    duration: 1,
    top: 0,
    ease: Power2.easeInOut,
  },
).fromTo(
  //テキストリンクを表示
  ".nav-link",
  {
    autoAlpha: 0,
    y: 30,
  },
  {
    autoAlpha: 1,
    y: 0,
    stagger: 0.3, //同じ要素一つずつに0.3s遅延をかけてアニメーションを行う
  },
)

Timelineは上から下にアニメーションの処理を順に行っていきます。
最初にメニューを上から下へ表示するためにtop: 0を指定して、CSSでtop: -100%;で隠している要素を0地点に戻しています。
上から下にメニューが表示されてから、テキストリンクアニメーションをスタートさせています。
またeasedurationはお好きに決めてください!
easeは下記を参考にしてください!

【GSAP】テキストアニメーションにイージング全種類で比較してみた!

GSAPのイージング全15種類をテキストアニメーションで比較検証。Power0〜4、Back、Elastic、Bounceなど各イージングの動きの違いをCodePenデモで確認できます。

これでアニメーションの記述はOKなのですが、Timelineの特性として、リロードのタイミングで発火してしまいます。
それを避けるためにTimelinepausedオプションでアニメーションを停止状態にさせます。

JavaScript
const tl = gsap.timeline({ paused: true })

Timelineには様々なメソッドがあるので、興味のある方は下記を参考にしてください!

Timeline | GSAP | Docs &amp; Learning

Returns : Timeline

greensock.com

あとは、先程準備したクリックイベントの記述にTimelineのアニメーションを動作させる記述を追記します。

Timelineの動作を発火させるにはplay()メソッドを、アニメーションを逆動作させるにはreverse()メソッドを使用します!

JavaScript
isMenuOpen.addEventListener("click", () => {
  tl.play()
})
 
isMenuClose.addEventListener("click", () => {
  tl.reverse()
})

これで、「MENU」をクリックするとメニューを表示し、「CLOSE」をクリックするとメニューを非表示できたと思います。

最後にメニューを開く動作と閉じる動作のアニメーション時間を操作して完了です。
アニメーション時間はtimeScale()メソッドを使用します。

JavaScript
isMenuOpen.addEventListener("click", () => {
  tl.play().timeScale(1)
})
 
isMenuClose.addEventListener("click", () => {
  tl.timeScale(3)
  tl.reverse()
})

timeScale()メソッドは引数の数字が、1=通常速度(デフォルト)、0.5=半速、2=倍速など、アニメーションの時間スケールに使用される係数になります。
対象.timeScale(係数)とすることで、対象のアニメーション時間を操作できます。
これでメニューを表示させる時間と非表示させる時間を操作できました!

最終的なコード

HTML
<body>
  <header class="nav">
    <div class="nav-bar">
      <h1 class="logo">TOKOS.inc</h1>
      <span class="open">MENU</span>
    </div>
  </header>
  <main class="menu">
    <span class="close">CLOSE</span>
    <div class="menu-container">
      <ul class="nav-list">
        <li class="nav-link"><a href="/">01.HOME</a></li>
        <li class="nav-link"><a href="/">02.SERVICE</a></li>
        <li class="nav-link"><a href="/">03.ABOUT</a></li>
      </ul>
    </div>
  </main>
</body>
CSS
body {
  font-family: "Times New Roman", Times, serif;
}
 
.nav {
  background-color: #333;
  padding: 24px 16px;
  box-shadow: 0px 2px 4px rgba(0, 0, 0, 0.4);
}
 
.nav-bar {
  display: flex;
  justify-content: space-between;
  align-items: center;
  color: #fff;
  max-width: 1200px;
  margin: auto;
}
 
.logo {
  font-size: 24px;
  font-weight: 600;
}
 
.open {
  cursor: pointer;
}
 
.menu {
  background-color: #000;
  color: #fff;
  width: 100%;
  height: 100vh;
  position: fixed;
  top: -100%;
}
 
.close {
  position: absolute;
  top: 24px;
  right: 32px;
  font-size: 24px;
  cursor: pointer;
}
 
.menu-container {
  max-width: 1200px;
  margin: auto;
  display: flex;
  align-items: center;
  height: 100%;
  font-size: 40px;
}
 
.nav-link {
  letter-spacing: 0.2rem;
}
JavaScript
const isMenuOpen = document.querySelector(".open")
const isMenuClose = document.querySelector(".close")
 
const tl = gsap.timeline({ paused: true })
tl.fromTo(
  ".menu",
  {
    autoAlpha: 0,
  },
  {
    autoAlpha: 1,
    duration: 1,
    top: 0,
    ease: Power2.easeInOut,
  },
).fromTo(
  ".nav-link",
  {
    autoAlpha: 0,
    y: 30,
  },
  {
    autoAlpha: 1,
    y: 0,
    stagger: 0.3,
  },
)
 
isMenuOpen.addEventListener("click", () => {
  tl.play().timeScale(1)
})
 
isMenuClose.addEventListener("click", () => {
  tl.timeScale(3)
  tl.reverse()
})

さいごに

今回はGSAPを用いてハンバーガーメニューを実装しました。
豊富なメソッドでかなり楽に実装できました。
イージングやアニメーション時間で印象もかなり変わってくるので、状況に応じて変更していこうと思いました。

この記事を書いた人

杉田侑祐
杉田侑祐

TOKOSのフロントエンドエンジニア兼UI/UXデザイナー。このブログではフロントエンドメインで投稿しています。HIPHOPとゲームが好きです✌️