dialog要素でモーダルウィンドウを実装する方法【コピペOK】
ボタンを押したらふわっと出てくる「モーダルウィンドウ」。
以前はjQueryのプラグインを入れたり、JavaScriptをたくさん書いたりして実装していましたが、今はHTMLのdialog要素を使えば、ほとんどの機能をブラウザが用意してくれます。
- 背景を暗くして、モーダルを一番手前に表示する
- Escキーで閉じる
- モーダルの後ろにあるリンクやボタンを押せなくする
- 閉じたら、開いたボタンにフォーカスを戻す
これらがJavaScript数行で手に入ります。
この記事では、dialog要素の基本から、背景クリックで閉じる・開閉アニメーション・背景のスクロール停止まで入れた実務でそのまま使える完成版コードを紹介します。
まずはデモ
下のボタンを押してみてください。Escキー、背景のクリック、「閉じる」ボタンのどれでも閉じられます。
デモのモーダルです
Escキー、背景のクリック、下の「閉じる」ボタンで閉じられます。
dialog要素とは?
dialog要素は、ダイアログ(小窓)を表示するためのHTMLの要素です。
JavaScriptのshowModal()で開くと「モーダル」として表示され、次のことをブラウザが自動でやってくれます。
- 一番手前に表示される:z-indexを指定しなくても、固定ヘッダーなどより必ず上に出ます(トップレイヤーという特別な層に表示されるため)
- 背景が付く:
::backdropという疑似要素で、後ろを暗くする背景をCSSで装飾できます - Escキーで閉じる
- 後ろのページを操作できなくなる:モーダルの外のリンクやボタンはクリックもTabキーでの移動もできなくなります
- フォーカスの管理:開くとモーダル内の最初のボタンなどにフォーカスが移り、閉じると開いたボタンに戻ります
自分で作ると意外と面倒な「アクセシビリティまわり」まで面倒を見てくれるのが、dialog要素を使う一番のメリットです。
show() と showModal() の違い
dialog要素を開くメソッドは2つあります。
showModal():モーダルとして開く(背景あり・Escで閉じる・後ろは操作不可)show():ただの小窓として開く(背景なし・後ろも操作できる)
いわゆる「モーダルウィンドウ」を作りたいときはshowModal()を使います。
基本のモーダルを作る
まずは一番シンプルな形です。
HTML
<button type="button" id="open-button">モーダルを開く</button> <dialog id="modal"> <p>モーダルの中身です。</p> <button type="button" id="close-button">閉じる</button> </dialog>
JavaScript
const modal = document.getElementById('modal');
document.getElementById('open-button').addEventListener('click', () => {
modal.showModal();
});
document.getElementById('close-button').addEventListener('click', () => {
modal.close();
});
これだけで、背景付きのモーダルが開き、Escキーと「閉じる」ボタンで閉じられます。
JavaScriptなしで閉じる方法
閉じるボタンをmethod="dialog"のformの中に置くと、JavaScriptを書かなくても押しただけで閉じます。
<dialog id="modal">
<p>モーダルの中身です。</p>
<form method="dialog">
<button>閉じる</button>
</form>
</dialog>
実務で使える完成版コード(コピペOK)
基本形に、実際の案件でよく求められる機能を足した完成版です。
- 背景(暗い部分)をクリックしたら閉じる
- 開くとき・閉じるときにアニメーションする
- モーダル表示中は後ろのページをスクロールさせない
- 1つのJavaScriptで、ページ内の複数のモーダルを扱える
- 「視差効果を減らす」設定のユーザーにはアニメーションしない
HTML
開くボタンのdata-modalに、開きたいdialogのidを書きます。モーダルを増やすときは、HTMLを追加するだけでOKです。
<button type="button" class="js-modal-open" data-modal="modal-1">モーダル1を開く</button>
<button type="button" class="js-modal-open" data-modal="modal-2">モーダル2を開く</button>
<dialog id="modal-1" class="modal" aria-labelledby="modal-1-title">
<div class="modal__inner">
<h2 id="modal-1-title">お知らせ</h2>
<p>モーダル1の中身です。</p>
<button type="button" class="js-modal-close">閉じる</button>
</div>
</dialog>
<dialog id="modal-2" class="modal" aria-labelledby="modal-2-title">
<div class="modal__inner">
<h2 id="modal-2-title">お問い合わせ</h2>
<p>モーダル2の中身です。</p>
<button type="button" class="js-modal-close">閉じる</button>
</div>
</dialog>
CSS
.modal {
width: min(90vw, 600px);
margin: auto; /* リセットCSSで margin: 0 になっていても中央に表示する */
padding: 0;
border: none;
border-radius: 8px;
}
.modal__inner {
padding: 32px 24px;
}
/* 背景の暗い部分 */
.modal::backdrop {
background-color: rgba(0, 0, 0, 0.6);
}
/* 開くときのアニメーション */
.modal[open] {
animation: modal-in 0.3s ease-out;
}
.modal[open]::backdrop {
animation: backdrop-in 0.3s ease-out;
}
/* 閉じるときのアニメーション */
.modal.is-closing {
animation: modal-out 0.2s ease-in forwards;
}
.modal.is-closing::backdrop {
animation: backdrop-out 0.2s ease-in forwards;
}
@keyframes modal-in {
from { opacity: 0; transform: translateY(16px); }
to { opacity: 1; transform: translateY(0); }
}
@keyframes modal-out {
from { opacity: 1; transform: translateY(0); }
to { opacity: 0; transform: translateY(16px); }
}
@keyframes backdrop-in {
from { opacity: 0; }
to { opacity: 1; }
}
@keyframes backdrop-out {
from { opacity: 1; }
to { opacity: 0; }
}
/* 動きを減らす設定のユーザーにはアニメーションしない */
@media (prefers-reduced-motion: reduce) {
.modal,
.modal::backdrop {
animation: none !important;
}
}
/* モーダル表示中は背景をスクロールさせない */
body:has(.modal[open]) {
overflow: hidden;
}
JavaScript
// 開くボタン:data-modal に書いた id のモーダルを開く
document.querySelectorAll('.js-modal-open').forEach((button) => {
button.addEventListener('click', () => {
document.getElementById(button.dataset.modal).showModal();
});
});
document.querySelectorAll('.modal').forEach((modal) => {
// 閉じるアニメーションが終わってから close() する
const closeModal = async () => {
if (modal.classList.contains('is-closing')) return;
modal.classList.add('is-closing');
await Promise.allSettled(modal.getAnimations().map((animation) => animation.finished));
modal.classList.remove('is-closing');
modal.close();
};
// 閉じるボタン
modal.querySelectorAll('.js-modal-close').forEach((button) => {
button.addEventListener('click', closeModal);
});
// 背景(::backdrop)をクリックしたら閉じる
modal.addEventListener('click', (event) => {
if (event.target === modal) closeModal();
});
// Escキー:すぐに閉じる標準の動きを止めて、アニメーション付きで閉じる
modal.addEventListener('cancel', (event) => {
event.preventDefault();
closeModal();
});
});
コードの解説
背景クリックで閉じる仕組み
暗い背景(::backdrop)をクリックすると、クリックイベントはdialog要素そのもので発生します。
そこでevent.target === modalのときだけ閉じるようにしています。
ポイントは、dialog要素のpaddingを0にして、余白は中の.modal__innerに付けていることです。
dialog要素にpaddingがあると、モーダルの内側の余白をクリックしたときもevent.targetがdialog要素になり、閉じてしまいます。
閉じるアニメーションの仕組み
close()を呼ぶとすぐに消えてしまうので、先にis-closingクラスを付けてアニメーションさせ、終わってからclose()しています。
アニメーションの終了はgetAnimations()で待っています。
animationendイベントで待つ方法もありますが、アニメーションを無効にしている環境ではイベントが発生せず、モーダルが閉じられなくなることがあります。getAnimations()なら、アニメーションがないときはすぐに閉じます。
また、Escキーで閉じたときにもアニメーションさせるため、cancelイベントで標準の「すぐ閉じる」動きを止めています。
背景のスクロールを止める
/* モーダル表示中は背景をスクロールさせない */
body:has(.modal[open]) {
overflow: hidden;
}
:has()を使うと「開いているモーダルを含むbody」を指定できるので、JavaScriptでクラスを付け外ししなくても、表示中だけスクロールを止められます。
スクロールバーが消える分、ページが横にずれるのが気になる場合は、html { scrollbar-gutter: stable; }を指定するとずれなくなります。
よくあるつまずき
リセットCSSを入れたら、モーダルが左上に表示される
dialog要素は、ブラウザの標準スタイルmargin: autoで画面中央に表示されています。
* { margin: 0; }のようなリセットCSSを使っていると、これが打ち消されて左上に張り付きます。
完成版コードのように、.modalにmargin: auto;を指定し直せば中央に戻ります。
display: flex を指定したら、閉じていても表示される
閉じているdialog要素は、ブラウザの標準スタイルdisplay: noneで隠れています。
中身を横並びにしようとして.modal { display: flex; }と書くと、これを上書きしてしまい、閉じているのに表示されたままになります。
/* NG:閉じていても表示されてしまう */
.modal {
display: flex;
}
/* OK:開いているときだけ flex にする */
.modal[open] {
display: flex;
}
[open]を付けて、開いているときだけ指定するようにしましょう。
z-indexを上げても固定ヘッダーの下に隠れる?
showModal()で開いていれば、z-indexに関係なく一番手前に表示されるので、z-indexの指定は不要です。
もし隠れてしまう場合は、show()で開いていないか確認してみてください。
開いたときに「閉じる」ボタンに枠線が出る
開くとモーダル内の最初の操作できる要素にフォーカスが移るため、ブラウザによってはフォーカスの枠線が表示されます。
最初にフォーカスさせたい要素がある場合は、その要素にautofocus属性を付けると指定できます。
キーボードで操作する人にとって大事な表示なので、枠線は消さないことをおすすめします。
対応ブラウザ
dialog要素は、Chrome・Edge・Firefox・Safariの現行バージョンすべてで使えます(Safari・Firefoxは2022年に対応)。
背景のスクロール停止で使っている:has()は、Firefoxが2023年12月(バージョン121)に対応したことで、主要ブラウザで使えるようになりました。
※この記事のコードはChromeで動作を確認しています。
まとめ
dialog要素を使えば、モーダルウィンドウに必要な機能の多くをブラウザに任せられます。
- 開くのは
showModal()、閉じるのはclose() - 背景は
::backdropで装飾 - 背景クリックで閉じるなら、dialogのpaddingは0にして
event.targetで判定 - リセットCSSを使っているなら
margin: auto、表示の指定は[open]に付ける
ライブラリを入れる前に、まずdialog要素を試してみてください。
あわせて読みたい
- ハンバーガーメニューを実装する【JavaScript・CSS】
- HTMLだけでアコーディオンを実装する方法
- JavaScriptでボタンを押したら指定要素にclassを追加・削除する方法
- サイトに小ウィンドウを簡単に出せる「WinBox.js」