[JavaScript] 初回アクセス時に1回だけポップアップ（モーダル）を表示したい

公開日:2019/07/25 更新日:2023/02/07

メンテナンスの予定など、必ず確認してもらいたいお知らせを通知する方法として、ポップアップ（モーダルウィンドウ）があります
ページを開く度に表示する必要はないため、二回目以降の訪問時には表示させないよう制御する必要があります
従来まではcookieで実現していた制御を、HTML5から追加されたlocalStorageで実装しました

サンプルコード

html

<div class="bg_onetime_popup">
    <div class="onetime_popup">
        <div class="onetime_popup_title">
            <span class="onetime_popup_title_close"></span>
            <span>お前はだれだ</span>
        </div>
        <div class="onetime_popup_content">
            <p>オレの中のオレ</p>
        </div>
    </div>
</div>

CSS

body.open_popup {
    overflow: hidden;
}

.bg_onetime_popup {
    position: fixed;
    top: 0px;
    left: 0px;
    z-index: 9999;
    width: 100vw;
    height: 100vh;
    background-color: rgba(0, 0, 0, 0.5);
    opacity: 0;
    visibility: hidden;
    transition: 0.5s;
}

body.open_popup .bg_onetime_popup {
    opacity: 1;
    visibility: visible;
}

.onetime_popup {
    position: absolute;
    top: 50%;
    left: 50%;
    transform: translateX(-50%) translateY(-50%);
    width: 50%;
    min-width: 500px;
    background-color: #fff;
}

.onetime_popup_title {
    position: relative;
    padding: 1em 80px;
    margin: 0px;
    background-color: #3388dd;
    color: #fff;
    font-size: 32px;
    text-align: center;
    line-height: 1.5;
}

.onetime_popup_title_close {
    position: absolute;
    top: 50%;
    right: 30px;
    width: 30px;
    height: 30px;
    transform: translateY(-50%);
    cursor: pointer;
}
.onetime_popup_title_close::before,
.onetime_popup_title_close::after {
    position: absolute;
    top: 50%;
    left: 50%;
    transform: translateX(-50%) translateY(-50%);
    width: 100%;
    height: 4px;
    background-color: #fff;
    content: "";
}
.onetime_popup_title_close::before {
    transform: translateX(-50%) translateY(-50%) rotate(45deg);
}
.onetime_popup_title_close::after {
    transform: translateX(-50%) translateY(-50%) rotate(-45deg);
}

.onetime_popup_content {
    padding: 60px 30px;
    text-align: center;
}

JavaScript

window.addEventListener('load', function() {
    if(!localStorage.getItem('disp_popup')) {
        localStorage.setItem('disp_popup', 'on');
        const body = document.querySelector('body');
        const bgPopup = document.querySelector('.bg_onetime_popup');
        const popup = document.querySelector('.onetime_popup');
        const popupTitleClose = document.querySelector('.onetime_popup_title_close');
        body.classList.add('open_popup');

        bgPopup.addEventListener('click', function() {
            closePopup();
        });
        popup.addEventListener('click', function(e) {
            e.stopPropagation();
        });
        popupTitleClose.addEventListener('click', function() {
            closePopup();
        });

        function closePopup() {
            body.classList.remove('open_popup');
        }
    }
}, false);

ページ読み込み時に、localStorageの有無をチェックし、保存されていなければポップアップにクラスを設定して表示させます

画面を表示してから数秒待ってポップアップを表示したい

window.addEventListener('load', function() {
    if(!localStorage.getItem('disp_popup')) {
        const dispPopup = function() {
            localStorage.setItem('disp_popup', 'on');
            const body = document.querySelector('body');
            const bgPopup = document.querySelector('.bg_onetime_popup');
            const popup = document.querySelector('.onetime_popup');
            const popupTitleClose = document.querySelector('.onetime_popup_title_close');
            body.classList.add('open_popup');

            bgPopup.addEventListener('click', function() {
                closePopup();
            });
            popup.addEventListener('click', function(e) {
                e.stopPropagation();
            });
            popupTitleClose.addEventListener('click', function() {
                closePopup();
            });

            function closePopup() {
                body.classList.remove('open_popup');
            }
        };
        setTimeout(dispPopup, 3000);
    }
}, false);

setTimeout関数を使用して、画面表示してから3秒経過後にポップアップを表示するサンプルです
setTimeoutの第二引数に指定する値を変えることで、ウェイトする秒数を変えることができます

ページを訪問する度に一度だけポップアップ表示したい

window.addEventListener('load', function() {
    if(!sessionStorage.getItem('disp_popup')) {
        sessionStorage.setItem('disp_popup', 'on');
        const body = document.querySelector('body');
        const bgPopup = document.querySelector('.bg_onetime_popup');
        const popup = document.querySelector('.onetime_popup');
        const popupTitleClose = document.querySelector('.onetime_popup_title_close');
        body.classList.add('open_popup');

        bgPopup.addEventListener('click', function() {
            closePopup();
        });
        popup.addEventListener('click', function(e) {
            e.stopPropagation();
        });
        popupTitleClose.addEventListener('click', function() {
            closePopup();
        });

        function closePopup() {
            body.classList.remove('open_popup');
        }
    }
}, false);

先述したサンプルでは、localStorageに保存されている限りポップアップは表示されなくなります
キャンペーン情報など、ページを開く度に通知をしたい場合は、localStorageではなく、sessionStorageを使用します
使用方法はlocalStorageとほとんど変わりません

更新履歴

2022/10/4：閉じるボタン、背景エリア以外をクリックしたときにポップアップが閉じないようにソースコードの見直しを行いました。
2022/10/12：モーダル下のページスクロールを防止する処理を追加しました。

ご質問など受け付けています

記事の中でわかりにくかったところ、もっと知りたかったこと、間違っていることなど、何でもお気軽にご連絡ください。

ご連絡は下記フォームを利用いただくか、ツイッターアカウント@flat8migi宛てでもOKです。