cookieを使って初回と一定期間経過後に表示されるモーダル(ポップアップ)ウィンドウをjavascriptで実装してみる(備忘録)

今回はjavascriptを用いて、cookieを使って初回と一定期間経過後に表示されるモーダル(ポップアップ)ウィンドウを実装してみる。

今回は一定期間の時間は30秒に設定している。30秒経過してからページを読み込んだときにcookieの値が削除され、再度モーダル(ポップアップ)ウィンドウが読み込まれるように設定している。

以前対応したローディング画面の時とほぼ同じ対応で実現できる。

参考記事はこちら

デモは下記を参考にしてほしい。

それでは解説に入っていく。

htmlの記述について

<!DOCTYPE html>
<html lang="ja">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>モーダル(ポップアップ)ウィンドウ</title>
  <link rel="stylesheet" href="../reset.css">
  <link rel="stylesheet" href="style.css">
</head>
<body>
  <main>
    <!-- モーダル(ポップアップ)の内容 -->
    <div class="js_modalWrap" id="js_modalWrap">
      <div class="js_modalBG" id="js_modalBG"></div>
      <div class="js_modalContInner">
        <span class="js_modalClose" id="js_modalClose"></span>
        <div class="js_modalCont">
          <p><img src="img_sample01.jpg" alt=""></p>
          <p>テキストテキスト</p>
        </div>
      </div>
    </div>
    <!-- //モーダル(ポップアップ)の内容 -->
    <section>
      <div class="ly_inner" id="menu1">
        <h2>menu1</h2>
        <div class="md_textblock">
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
        </div>
      </div>
    </section>
    <section>
      <div class="ly_inner" id="menu2">
        <h2>menu2</h2>
        <div class="md_textblock">
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
        </div>
      </div>
    </section>
    <section>
      <div class="ly_inner" id="menu3">
        <h2>menu3</h2>
        <div class="md_textblock">
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
        </div>
      </div>
    </section>
    <section>
      <div class="ly_inner" id="menu4">
        <h2>menu4</h2>
        <div class="md_textblock">
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
        </div>
      </div>
    </section>
    <section>
      <div class="ly_inner" id="menu5">
        <h2>menu5</h2>
        <div class="md_textblock">
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
          <p>テキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入りますテキストが入ります</p>
        </div>
      </div>
    </section>
  </main>
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
  <script src="style.js"></script>
</body>
</html>

htmlの記述は前回の記事と全く一緒のため、解説は割愛する。

前回の記事はこちら

cssの記述について

@charset "utf-8";

/* ==========================
  初期設定
========================== */
*,
*::before,
*::after {
  box-sizing: border-box;
}
img {
  width: 100%;
}

/* ==========================
  モーダル(ポップアップ)
========================== */
.js_modalBtnWrap {
  width: 300px;
  max-width: 100%;
  margin: 0 auto;
  text-align: center;
}
.js_modalWrap {
  opacity: 0;
  z-index: -1;
  position: fixed;
  left: 0;
  top: 0;
  width: 100%;
  height: 100%;
}
.js_modalWrap.active {
  animation: modalOpen 0.3s ease forwards;
}
.js_modalWrap.active2 {
  animation: modalClose 0.3s ease forwards;
}
.js_modalBG {
  position: absolute;
  top: 0;
  left: 0;
  width: 100%;
  height: 100%;
  background-color: rgba(0, 0, 0, 0.6);
}
.js_modalContInner {
  position: absolute;
  top: 50%;
  left: 50%;
  transform: translateX(-50%) translateY(-50%);
  width: 720px;
  max-width: 100%;
  background-color: #fff;
  max-height: 600px;
  padding: 40px;
}
.js_modalCont {
  overflow-y: scroll;
  max-height: 520px;
}
.js_modalCont > * + * {
  margin-top: 10px;
}
.js_modalContInner > .js_modalClose + * {
  margin-top: 0;
}
.js_modalClose {
  display: block;
  position: absolute;
  top: 10.5px;
  right: 10.5px;
  width: 20px;
  height: 20px;
  overflow: hidden;
  cursor: pointer;
  z-index: 1001;
}
.js_modalClose::before,
.js_modalClose::after {
  content: "";
  background-color: #222;
  position: absolute;
  top: -5px;
  right: 10px;
  width: 1px;
  height: 30px;
}
.js_modalClose::before {
  transform: rotate(45deg);
}
.js_modalClose::after {
  transform: rotate(-45deg);
}

@keyframes modalOpen {
  0% {
    opacity: 0;
  }
  100% {
    opacity: 1;
    z-index: 1000;
  }
}
@keyframes modalClose {
  0% {
    opacity: 1;
    z-index: 1000;
  }
  100% {
    opacity: 0;
  }
}

/* ==========================
  コンテンツの中身
========================== */
.ly_inner {
  width: 100%;
  max-width: 1080px;
  margin: 100px auto;
  padding: 40px;
  background-color: #ccc;
}
.ly_inner h2 {
  font-size: 150%;
  font-weight: bold;
  margin-bottom: 30px;
}
.md_textblock > * + * {
  margin-top: 10px;
}
.md_textblock > * + .js_modalBtnWrap {
  margin-top: 20px;
}

/* PC幅に適用 */
@media (min-width: 768px) {
  .hp_sp {
    display: none !important;
  }
}
/* スマホ幅に適用 */
@media (max-width: 767px) {
  .hp_pc {
    display: none !important;
  }
  .js_modalContInner {
    max-height: 400px;
    padding: 20px;
  }
  .js_modalCont {
    max-height: 360px;
  }
  .js_modalClose {
    top: -30px;
  }
  .js_modalClose::before,
  .js_modalClose::after {
    background-color: #fff;
  }
}

cssの記述についても、前回の記事同様のため解説は割愛する。

前回の記事はこちら

javascriptの記述について

'use strict';

// モーダル(ポップアップ)
const modalWindow = document.getElementById('js_modalWrap');
const modalClose = document.getElementById('js_modalClose');
const modalBG = document.getElementById('js_modalBG');

if (document.cookie.indexOf('visited=first') === -1) {
  document.cookie = 'visited=first path=/' + ';max-age=30';
  window.addEventListener('load', function () {
    modalWindow.classList.add('active');
  });
} else {
  window.addEventListener('load', function () {
    modalWindow.classList.remove('active');
  });
}

modalBG.addEventListener('click', function () {
  modalWindow.classList.add('active2');
  setTimeout(function() {
    modalWindow.classList.remove('active');
    modalWindow.classList.remove('active2');
  }, 300);
})
modalClose.addEventListener('click', function () {
  modalWindow.classList.add('active2');
  setTimeout(function() {
    modalWindow.classList.remove('active');
    modalWindow.classList.remove('active2');
  }, 300);
})

前回との違いは、下記の記述部分である。

if (document.cookie.indexOf('visited=first') === -1) {
  document.cookie = 'visited=first path=/' + ';max-age=30';
  window.addEventListener('load', function () {
    modalWindow.classList.add('active');
  });
} else {
  window.addEventListener('load', function () {
    modalWindow.classList.remove('active');
  });
}

最初にページを読み込んだとき、cookieの値が入っていないときにindexOfの値が-1を返す特性を利用して、cookieのkeyとvalueの値を、それぞれvisitedとfirstと設定する。

そして、max-ageでcookieを何秒後に削除したいかを秒数(今回は30秒)で設定し、cookieの情報が削除されるとページをリロードしたときにモーダル(ポップアップ)ウィンドウが再び表示されるように対応している。

あとはelseでそれ以外(keyにvistedの値が設定されている)の場合に、モーダルウィンドウが表示されないようactiveのクラスが取り除かれるように対応している。

また、冒頭でも触れたが、cookieについては、下記の記事でもあげているので参考にしてみて欲しい。

参考記事はこちら

その他の部分の記述は前回の記事と同様である。

以上で実装完了だ。