モーダル
Modal
モーダルでは, JavaScript modal プラグインを使用して, ライトボックス, 通知, カスタムダイアログを作成できます。モーダルの使い方の例を示します。
基礎知識
Bootstrapのモーダルコンポーネントを使い始める前に、メニューオプションが変更されたので、以下を確認して下さい。
- モーダルはHTML、CSS、JavaScriptで構築されます。モーダルはドキュメント内の他のすべてのものの上に配置され、
<body>
からスクロールを取り除き、モーダルのコンテンツがスクロールするようにします。 - モーダルの「背景」をクリックすると、自動的にモーダルが閉じます。
- Bootstrapは、一度に1つのモーダルウィンドウしかサポートしていません。ネスト(入れ子)になったモーダルはユーザーエクスペリエンスが低いと考えられるためサポートされていません。
- モーダルは
position: fixedを使用します。可能な限り、他の要素との干渉を避けるために、モーダルHTMLをトップレベルの位置に配置してください。別の固定要素の中に
.modalを入れ子にすると、問題が発生する可能性があります。 - 繰り返しになりますが、
position: fixed
のため、モバイルデバイスでモーダルを使用する際にはいくつかの注意点があります。詳細はSee our browser support docsを参照してください。 - HTML5がそのセマンティクスを定義する方法のため,
autofocus
のHTML属性はBootstrapのモーダルでは効果がありません。同じ効果を得るためには、いくつかのカスタムJavaScriptを使用してください。
const myModal = document.getElementById('myModal')
const myInput = document.getElementById('myInput')
myModal.addEventListener('shown.bs.modal', () => {
myInput.focus()
})
prefers-reduced-motion
メディアクエリに依存します。アクセシビリティのドキュメントのモーションの低減セクション を参照してください。
デモと使用ガイドラインについては、引き続きお読みください。
例
モーダルコンポーネント
以下は static モーダルの例です(つまり、position
とdisplay
がオーバーライドされていることを意味します)。これには、モーダルヘッダ、モーダルボディ(padding
のために必要)、モーダルフッタ(オプション)が含まれています。可能な限り、モーダルヘッダをdismissアクションと一緒に含めるか、別の明示的なdismissアクションを提供するようにお願いします。
<div class="modal" tabindex="-1">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h5 class="modal-title">Modal title</h5>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>Modal body text goes here.</p>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
<button type="button" class="btn btn-primary">Save changes</button>
</div>
</div>
</div>
</div>
<h5>
を使用しています。しかし、構造上、モーダルダイアログはそれ自身の独立したドキュメント/コンテキストを表しますので、.modal-title
は<h1>
であることが理想的です。必要であれば、フォントサイズユーティリティを使用して、見出しの外観を制御することができます。以下のライブサンプルはすべてこの方法を使っています。
ライブデモ
下のボタンをクリックして、モーダルデモをトグルします。ページの上からスライドダウンしてフェードインします。
<!-- Button trigger modal -->
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal">
Launch demo modal
</button>
<!-- Modal -->
<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="exampleModalLabel">Modal title</h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
...
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
<button type="button" class="btn btn-primary">Save changes</button>
</div>
</div>
</div>
</div>
静的なバックドロップ
バックドロップを静的に設定していると、その外側をクリックしてもモーダルが閉じません。下のボタンをクリックして試してみてください。
<!-- Button trigger modal -->
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#staticBackdrop">
Launch static backdrop modal
</button>
<!-- Modal -->
<div class="modal fade" id="staticBackdrop" data-bs-backdrop="static" data-bs-keyboard="false" tabindex="-1" aria-labelledby="staticBackdropLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="staticBackdropLabel">Modal title</h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
...
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
<button type="button" class="btn btn-primary">Understood</button>
</div>
</div>
</div>
</div>
長いコンテンツをスクロールする
モーダルがユーザーのビューポートやデバイスに対して長すぎると、ページ自体から独立してスクロールします。以下のデモを試してみてください。
また、.modal-dialog
に.modal-dialog-scrollable
を追加することで、モーダル本体をスクロールできるスクロール可能なモーダルを作成することもできます。
<!-- Scrollable modal -->
<div class="modal-dialog modal-dialog-scrollable">
...
</div>
縦垂直方向の中央に配置
モーダルを垂直方向の中央に配置するために.modal-dialog-centered
を.modal-dialog
に追加します。
<!-- Vertically centered modal -->
<div class="modal-dialog modal-dialog-centered">
...
</div>
<!-- Vertically centered scrollable modal -->
<div class="modal-dialog modal-dialog-centered modal-dialog-scrollable">
...
</div>
ツールチップとポップオーバー
ツールチップとポップオーバーは、必要に応じてモーダル内に配置することができます。モーダルが閉じられると、その中にあるツールチップやポップオーバーも自動的に削除されます。
<div class="modal-body">
<h2 class="fs-5">Popover in a modal</h2>
<p>This <button class="btn btn-secondary" data-bs-toggle="popover" title="Popover title" data-bs-content="Popover body content is set in this attribute.">button</button> triggers a popover on click.</p>
<hr>
<h2 class="fs-5">Tooltips in a modal</h2>
<p><a href="#" data-bs-toggle="tooltip" title="Tooltip">This link</a> and <a href="#" data-bs-toggle="tooltip" title="Tooltip">that link</a> have tooltips on hover.</p>
</div>
グリッドシステムを利用
.modal-body
の中に.container-fluid
を入れ子にすることで、モーダル内のグリッドシステムを利用します。
<div class="modal-body">
<div class="container-fluid">
<div class="row">
<div class="col-md-4">.col-md-4</div>
<div class="col-md-4 ms-auto">.col-md-4 .ms-auto</div>
</div>
<div class="row">
<div class="col-md-3 ms-auto">.col-md-3 .ms-auto</div>
<div class="col-md-2 ms-auto">.col-md-2 .ms-auto</div>
</div>
<div class="row">
<div class="col-md-6 ms-auto">.col-md-6 .ms-auto</div>
</div>
<div class="row">
<div class="col-sm-9">
Level 1: .col-sm-9
<div class="row">
<div class="col-8 col-sm-6">
Level 2: .col-8 .col-sm-6
</div>
<div class="col-4 col-sm-6">
Level 2: .col-4 .col-sm-6
</div>
</div>
</div>
</div>
</div>
</div>
モーダルコンテンツの変更
クリックされたボタンに応じて、モーダルの内容を変更できます。event.relatedTarget
とHTMLのdata-bs-*
属性を使用してください。
以下は、HTMLとJavaScriptの例に続くライブデモです。relatedTarget
の詳細はread the modal events docsを参考にしてください。
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@mdo">Open modal for @mdo</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@fat">Open modal for @fat</button>
<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#exampleModal" data-bs-whatever="@getbootstrap">Open modal for @getbootstrap</button>
<div class="modal fade" id="exampleModal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="exampleModalLabel">New message</h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<form>
<div class="mb-3">
<label for="recipient-name" class="col-form-label">Recipient:</label>
<input type="text" class="form-control" id="recipient-name">
</div>
<div class="mb-3">
<label for="message-text" class="col-form-label">Message:</label>
<textarea class="form-control" id="message-text"></textarea>
</div>
</form>
</div>
<div class="modal-footer">
<button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
<button type="button" class="btn btn-primary">Send message</button>
</div>
</div>
</div>
</div>
const exampleModal = document.getElementById('exampleModal')
if (exampleModal) {
exampleModal.addEventListener('show.bs.modal', event => {
// Button that triggered the modal
const button = event.relatedTarget
// Extract info from data-bs-* attributes
const recipient = button.getAttribute('data-bs-whatever')
// If necessary, you could initiate an Ajax request here
// and then do the updating in a callback.
// Update the modal's content.
const modalTitle = exampleModal.querySelector('.modal-title')
const modalBodyInput = exampleModal.querySelector('.modal-body input')
modalTitle.textContent = `New message to ${recipient}`
modalBodyInput.value = recipient
})
}
Toggle between modals
data-bs-target
属性とdata-bs-toggle
属性を利用して、複数のモーダルを切り替え可能です。複数のモーダルを同時に開くことはできないことに注意してください —この方法は、2つの別々のモーダルを切り替えるだけです。
<div class="modal fade" id="exampleModalToggle" aria-hidden="true" aria-labelledby="exampleModalToggleLabel" tabindex="-1">
<div class="modal-dialog modal-dialog-centered">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="exampleModalToggleLabel">Modal 1</h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
Show a second modal and hide this one with the button below.
</div>
<div class="modal-footer">
<button class="btn btn-primary" data-bs-target="#exampleModalToggle2" data-bs-toggle="modal">Open second modal</button>
</div>
</div>
</div>
</div>
<div class="modal fade" id="exampleModalToggle2" aria-hidden="true" aria-labelledby="exampleModalToggleLabel2" tabindex="-1">
<div class="modal-dialog modal-dialog-centered">
<div class="modal-content">
<div class="modal-header">
<h1 class="modal-title fs-5" id="exampleModalToggleLabel2">Modal 2</h1>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
Hide this modal and show the first with the button below.
</div>
<div class="modal-footer">
<button class="btn btn-primary" data-bs-target="#exampleModalToggle" data-bs-toggle="modal">Back to first</button>
</div>
</div>
</div>
</div>
<button class="btn btn-primary" data-bs-target="#exampleModalToggle" data-bs-toggle="modal">Open first modal</button>
アニメーションの変更
変数$modal-fade-transform
はモーダルフェードインアニメーションの前の.modal-dialog
のトランスフォーム状態を決定し、変数$modal-show-transform
はモーダルフェードインアニメーションの終了時の.modal-dialog
のトランスフォーム状態を決定します。
例えばズームインアニメーションを作りたい場合は、$modal-fade-transform: scale(.8)
を設定します。
### アニメーションの削除
フェードインして表示するのではなく、単に表示するだけのモーダルの場合は、.fade
クラスを削除します。
<div class="modal" tabindex="-1" aria-labelledby="..." aria-hidden="true">
...
</div>
動的な高さ
モーダルの高さが開いている間に変更された場合は、スクロールバーが表示されたときのモーダルの位置を再調整するためにmyModal.handleUpdate()
を呼び出す必要があります。
アクセシビリティ
必ず.modal
にモーダルのタイトルを参照するaria-labelledby="...."
を追加してください。さらに、.modal
にaria-describedby
を追加することで、モーダルダイアログの説明を与えることができます。JavaScriptで既に追加しているので、role="dialog"
を追加する必要はありません。
YouTubeビデオを埋め込む
YouTubeの動画をモーダルに埋め込むには、BootstrapにはないJavaScriptを追加して自動で再生を停止させるなどの工夫が必要です。詳しくは、このStack Overflowの投稿を参照にしてください。
オプションのサイズ
モーダルには3つのオプションサイズがあり、.modal-dialog
に配置する修飾クラスで利用できます。これらのサイズは、狭いビューポートでの水平スクロールバーを避けるために、特定のブレイクポイントで有効になります。
Size | Class | Modal max-width |
---|---|---|
Small | .modal-sm |
300px |
Default | None | 500px |
Large | .modal-lg |
800px |
Extra large | .modal-xl |
1140px |
デフォルトは"medium"サイズのモーダルです。
<div class="modal-dialog modal-xl">...</div>
<div class="modal-dialog modal-lg">...</div>
<div class="modal-dialog modal-sm">...</div>
フルスクリーンモーダル
もう1つのオーバーライドは、ユーザーのビューポートをカバーするモーダルをポップアップするオプションで、.modal-dialog
に配置される修飾クラスで利用できます。
Class | Availability |
---|---|
.modal-fullscreen |
Always |
.modal-fullscreen-sm-down |
576px |
.modal-fullscreen-md-down |
768px |
.modal-fullscreen-lg-down |
992px |
.modal-fullscreen-xl-down |
1200px |
.modal-fullscreen-xxl-down |
1400px |
<!-- Full screen modal -->
<div class="modal-dialog modal-fullscreen-sm-down">
...
</div>
CSS
変数
Added in v5.2.0Bootstrapの進化するCSS変数アプローチの一環として、モーダルでは.modal
と.modal-backdrop
でローカル CSS 変数を使用するようになり、リアルタイムのカスタマイズが強化されました。CSS変数の値はSass経由で設定されるため、Sassによるカスタマイズも引き続きサポートされます。
--#{$prefix}modal-zindex: #{$zindex-modal};
--#{$prefix}modal-width: #{$modal-md};
--#{$prefix}modal-padding: #{$modal-inner-padding};
--#{$prefix}modal-margin: #{$modal-dialog-margin};
--#{$prefix}modal-color: #{$modal-content-color};
--#{$prefix}modal-bg: #{$modal-content-bg};
--#{$prefix}modal-border-color: #{$modal-content-border-color};
--#{$prefix}modal-border-width: #{$modal-content-border-width};
--#{$prefix}modal-border-radius: #{$modal-content-border-radius};
--#{$prefix}modal-box-shadow: #{$modal-content-box-shadow-xs};
--#{$prefix}modal-inner-border-radius: #{$modal-content-inner-border-radius};
--#{$prefix}modal-header-padding-x: #{$modal-header-padding-x};
--#{$prefix}modal-header-padding-y: #{$modal-header-padding-y};
--#{$prefix}modal-header-padding: #{$modal-header-padding}; // Todo in v6: Split this padding into x and y
--#{$prefix}modal-header-border-color: #{$modal-header-border-color};
--#{$prefix}modal-header-border-width: #{$modal-header-border-width};
--#{$prefix}modal-title-line-height: #{$modal-title-line-height};
--#{$prefix}modal-footer-gap: #{$modal-footer-margin-between};
--#{$prefix}modal-footer-bg: #{$modal-footer-bg};
--#{$prefix}modal-footer-border-color: #{$modal-footer-border-color};
--#{$prefix}modal-footer-border-width: #{$modal-footer-border-width};
--#{$prefix}backdrop-zindex: #{$zindex-modal-backdrop};
--#{$prefix}backdrop-bg: #{$modal-backdrop-bg};
--#{$prefix}backdrop-opacity: #{$modal-backdrop-opacity};
Sass変数
$modal-inner-padding: $spacer;
$modal-footer-margin-between: .5rem;
$modal-dialog-margin: .5rem;
$modal-dialog-margin-y-sm-up: 1.75rem;
$modal-title-line-height: $line-height-base;
$modal-content-color: null;
$modal-content-bg: var(--#{$prefix}body-bg);
$modal-content-border-color: var(--#{$prefix}border-color-translucent);
$modal-content-border-width: var(--#{$prefix}border-width);
$modal-content-border-radius: var(--#{$prefix}border-radius-lg);
$modal-content-inner-border-radius: subtract($modal-content-border-radius, $modal-content-border-width);
$modal-content-box-shadow-xs: $box-shadow-sm;
$modal-content-box-shadow-sm-up: $box-shadow;
$modal-backdrop-bg: $black;
$modal-backdrop-opacity: .5;
$modal-header-border-color: var(--#{$prefix}border-color);
$modal-header-border-width: $modal-content-border-width;
$modal-header-padding-y: $modal-inner-padding;
$modal-header-padding-x: $modal-inner-padding;
$modal-header-padding: $modal-header-padding-y $modal-header-padding-x; // Keep this for backwards compatibility
$modal-footer-bg: null;
$modal-footer-border-color: $modal-header-border-color;
$modal-footer-border-width: $modal-header-border-width;
$modal-sm: 300px;
$modal-md: 500px;
$modal-lg: 800px;
$modal-xl: 1140px;
$modal-fade-transform: translate(0, -50px);
$modal-show-transform: none;
$modal-transition: transform .3s ease-out;
$modal-scale-transform: scale(1.02);
Sassループ
レスポンシブ・フルスクリーンモーダルは$breakpoints
マップとscss/_modal.scss
のループによって生成されます。
@each $breakpoint in map-keys($grid-breakpoints) {
$infix: breakpoint-infix($breakpoint, $grid-breakpoints);
$postfix: if($infix != "", $infix + "-down", "");
@include media-breakpoint-down($breakpoint) {
.modal-fullscreen#{$postfix} {
width: 100vw;
max-width: none;
height: 100%;
margin: 0;
.modal-content {
height: 100%;
border: 0;
@include border-radius(0);
}
.modal-header,
.modal-footer {
@include border-radius(0);
}
.modal-body {
overflow-y: auto;
}
}
}
}
使い方
モーダルプラグインは、データ属性またはJavaScriptを使用して、非表示のコンテンツをオンデマンドで切り替えます。また、デフォルトのスクロール動作をオーバーライドし、.modal-backdrop
を生成して、モーダルの外側をクリックしたときに表示されているモーダルを解除するためのクリック領域を提供します。
データ属性経由
トグル
JavaScriptを書かずにモーダルをアクティブにします。ボタンのようなコントローラ要素にdata-bs-toggle="modal"
を設定し、data-bs-target="#foo"
またはhref="#foo"
を指定すると、特定のモーダルをターゲットとしてトグルします。
<button type="button" data-bs-toggle="modal" data-bs-target="#myModal">Launch modal</button>
解除
以下に示すようにdata-bs-dismiss
属性を使って、modal内のボタンで終了させることができます:
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
または、以下のようにdata-bs-target
を使ってmodalの外側のボタンに追加します:
<button type="button" class="btn-close" data-bs-dismiss="modal" data-bs-target="#my-modal" aria-label="Close"></button>
JavaScript
1行のJavaScriptでモーダルを作成します:
const myModal = new bootstrap.Modal(document.getElementById('myModal'), options)
// or
const myModalAlternative = new bootstrap.Modal('#myModal', options)
オプション
オプションはデータ属性やJavaScriptで渡すことができるので、data-bs-animation="{value}"
のように、data-bs-
にオプション名を付加することができる。データ属性でオプションを渡す場合は、オプション名の大文字と小文字を"camelCase“から”kebab-case“に変更することを忘れないようにしましょう。例えば、data-bs-customClass="beautifier"
の代わりに data-bs-custom-class="beautifier"
を使用します。
Bootstrap 5.2.0では、全てのコンポーネントが 実験的 予約データ属性 data-bs-config
をサポートしており、JSON文字列として簡単なコンポーネント設定を収容することができます。要素に data-bs-config='{"delay":0, "title":123}'
とdata-bs-title="456"
属性がある場合、 title
の最終値は 456
で、別々のデータ属性は data-bs-config
で与えられた値を上書きする。また、既存のデータ属性にはdata-bs-delay='{"show":0, "hide":150}'
のようなJSON値を格納することができるようになっています。
最終的なコンフィギュレーションオブジェクトは data-bs-config
、data-bs-
、js object
のマージ結果であり、最新のキー値が他の値を上書きする。
Name | Type | Default | Description |
---|---|---|---|
backdrop |
boolean, 'static' |
true |
モーダルバックドロップ要素を含みます。クリックしてもモーダルが閉じないバックドロップにはstatic を指定します。 |
focus |
boolean | true |
初期化時にモーダルにフォーカスを当てます。 |
keyboard |
boolean | true |
エスケープキーを押すとモーダルを閉じます。 |
Methods
オプションの受け渡し
コンテンツをモーダルとして有効化します。オプションとしてobject
を受け取ることも可能です。
const myModal = new bootstrap.Modal('#myModal', {
keyboard: false
})
Method | Description |
---|---|
dispose |
要素のモーダルを破壊します。(DOM要素上の保存データを削除します) |
getInstance |
DOM要素に関連付けられたモーダルのインスタンスを取得するための静的な静的なメソッドです。 |
getOrCreateInstance |
DOM要素に関連付けられたモーダルのインスタンスを取得する、または初期化されていない場合は新たに作成するための静的メソッドです。 |
handleUpdate |
モーダルが開いている間にモーダルの高さが変わると(つまり、スクロールバーが現れる場合など)モーダルの位置を手動で再調整します。 |
hide |
モーダルを手動で非表示にします。実際にモーダルが非表示になる前(つまり、hidden.bs.modal イベントが発生する前)に呼び出し元に戻ります。 |
show |
モーダルを手動で開きます。実際にモーダルが表示される前(つまり、shown.bs.modal イベントが発生する前)に呼び出し元に戻ります。 また、モーダルのイベントで受け取ることができる引数としてDOM要素を渡すこともできます(relatedTarget プロパティとして)。(例:const modalToggle = document.getElementById('toggleMyModal'); myModal.show(modalToggle) ) |
toggle |
モーダルを手動で切り替えます。モーダルが実際に表示されたり非表示になったりする前(つまり、shown.bs.modal またはhidden.bs.modal イベントが発生する前)に呼び出し元に戻ります。 |
イベント
Bootstrapのモーダルは、モーダル機能にフックするためのいくつかのイベントを公開しています。すべてのモーダルイベントはモーダル自体で発生します(つまり、<div class="modal">
で発生します)。
Event | Description |
---|---|
hide.bs.modal |
このイベントはhide インスタンスメソッドが呼び出されると直ちに発生します。 |
hidden.bs.modal |
このイベントは、モーダルをユーザーから隠し終わったときに発生します(CSSトランジションが完了するまで待機します)。 |
hidePrevented.bs.modal |
このイベントは、モーダルが表示され、その背景がstatic で、モーダルの外側をクリックしたときに発生します。このイベントはエスケープキーが押され、keyboard オプションがfalse に設定されたときにも発生します |
show.bs.modal |
このイベントはshow インスタンスメソッドが呼び出されると即座に発生します。クリックによって発生した場合、クリックされた要素はイベントのrelatedTarget プロパティとして利用可能です。 |
shown.bs.modal |
このイベントは、モーダルがユーザーに表示されたときに発生します(CSSトランジションが完了するまで待機します)。クリックによって発生した場合、クリックされた要素がイベントのrelatedTarget プロパティとして利用できます。 |
const myModalEl = document.getElementById('myModal')
myModalEl.addEventListener('hidden.bs.modal', event => {
// do something...
})