アラート
少数の利用可能で柔軟なアラート メッセージを使用して、典型的なユーザー アクションに対してコンテキスト フィードバック メッセージを提供します。
例
任意の長さのテキストとオプションの閉じるボタンでアラートを利用できます。適切なスタイルを設定するには、8 つの必須コンテキスト クラスのいずれかを使用します (例: .alert-success
)。インラインで却下するには、アラート JavaScript プラグインを使用します。
<div class="alert alert-primary" role="alert">
A simple primary alert—check it out!
</div>
<div class="alert alert-secondary" role="alert">
A simple secondary alert—check it out!
</div>
<div class="alert alert-success" role="alert">
A simple success alert—check it out!
</div>
<div class="alert alert-danger" role="alert">
A simple danger alert—check it out!
</div>
<div class="alert alert-warning" role="alert">
A simple warning alert—check it out!
</div>
<div class="alert alert-info" role="alert">
A simple info alert—check it out!
</div>
<div class="alert alert-light" role="alert">
A simple light alert—check it out!
</div>
<div class="alert alert-dark" role="alert">
A simple dark alert—check it out!
</div>
支援技術に意味を伝える
色を使用して意味を追加しても、視覚的な指示しか提供されず、スクリーン リーダーなどの支援技術のユーザーには伝わりません。.visually-hidden
色で示される情報が、コンテンツ自体 (表示されるテキストなど) から明らかであるか、クラスで非表示の追加テキストなどの代替手段によって含まれていることを確認してください。
実際の例
下のボタンをクリックしてアラートを表示し (開始するにはインライン スタイルで非表示)、組み込みの [閉じる] ボタンでアラートを閉じます (そして破棄します)。
<div id="liveAlertPlaceholder"></div>
<button type="button" class="btn btn-primary" id="liveAlertBtn">Show live alert</button>
次の JavaScript を使用して、ライブ アラートのデモをトリガーします。
const alertPlaceholder = document.getElementById('liveAlertPlaceholder')
const alert = (message, type) => {
const wrapper = document.createElement('div')
wrapper.innerHTML = [
`<div class="alert alert-${type} alert-dismissible" role="alert">`,
` <div>${message}</div>`,
' <button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>',
'</div>'
].join('')
alertPlaceholder.append(wrapper)
}
const alertTrigger = document.getElementById('liveAlertBtn')
if (alertTrigger) {
alertTrigger.addEventListener('click', () => {
alert('Nice, you triggered this alert message!', 'success')
})
}
リンクの色
ユーティリティ クラスを使用して、.alert-link
アラート内に一致する色付きのリンクをすばやく提供します。
<div class="alert alert-primary" role="alert">
A simple primary alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-secondary" role="alert">
A simple secondary alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-success" role="alert">
A simple success alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-danger" role="alert">
A simple danger alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-warning" role="alert">
A simple warning alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-info" role="alert">
A simple info alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-light" role="alert">
A simple light alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
<div class="alert alert-dark" role="alert">
A simple dark alert with <a href="#" class="alert-link">an example link</a>. Give it a click if you like.
</div>
追加コンテンツ
アラートには、見出し、段落、仕切りなどの追加の HTML 要素を含めることもできます。
素晴らしい!
ああ、あなたはこの重要な警告メッセージを読みました。この例のテキストは、アラート内のスペースがこの種のコンテンツでどのように機能するかを確認できるように、少し長くなります。
必要なときはいつでも、マージン ユーティリティを使用して物事を整理整頓してください。
<div class="alert alert-success" role="alert">
<h4 class="alert-heading">Well done!</h4>
<p>Aww yeah, you successfully read this important alert message. This example text is going to run a bit longer so that you can see how spacing within an alert works with this kind of content.</p>
<hr>
<p class="mb-0">Whenever you need to, be sure to use margin utilities to keep things nice and tidy.</p>
</div>
アイコン
同様に、フレックスボックス ユーティリティとBootstrap Iconsを使用して、アイコン付きのアラートを作成できます。アイコンとコンテンツによっては、さらにユーティリティやカスタム スタイルを追加したい場合があります。
<div class="alert alert-primary d-flex align-items-center" role="alert">
<svg xmlns="http://www.w3.org/2000/svg" class="bi bi-exclamation-triangle-fill flex-shrink-0 me-2" viewBox="0 0 16 16" role="img" aria-label="Warning:">
<path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5zm.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2z"/>
</svg>
<div>
An example alert with an icon
</div>
</div>
アラートに複数のアイコンが必要ですか? より多くのブートストラップ アイコンを使用し、同じアイコンを繰り返し簡単に参照できるように、ローカル SVG スプライトを作成することを検討してください。
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="check-circle-fill" viewBox="0 0 16 16">
<path d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zm-3.97-3.03a.75.75 0 0 0-1.08.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-.01-1.05z"/>
</symbol>
<symbol id="info-fill" viewBox="0 0 16 16">
<path d="M8 16A8 8 0 1 0 8 0a8 8 0 0 0 0 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194 0 .487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703 0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 1 1 0-2 1 1 0 0 1 0 2z"/>
</symbol>
<symbol id="exclamation-triangle-fill" viewBox="0 0 16 16">
<path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5zm.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2z"/>
</symbol>
</svg>
<div class="alert alert-primary d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" role="img" aria-label="Info:"><use xlink:href="#info-fill"/></svg>
<div>
An example alert with an icon
</div>
</div>
<div class="alert alert-success d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" role="img" aria-label="Success:"><use xlink:href="#check-circle-fill"/></svg>
<div>
An example success alert with an icon
</div>
</div>
<div class="alert alert-warning d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" role="img" aria-label="Warning:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
An example warning alert with an icon
</div>
</div>
<div class="alert alert-danger d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" role="img" aria-label="Danger:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
An example danger alert with an icon
</div>
</div>
却下
アラート JavaScript プラグインを使用すると、アラートをインラインで無視できます。方法は次のとおりです。
- アラート プラグインまたはコンパイル済みの Bootstrap JavaScript をロードしたことを確認してください。
- 閉じるボタンとクラスを追加
.alert-dismissible
します。これにより、アラートの右側に余分なパディングが追加され、閉じるボタンが配置されます。 - 閉じるボタンで
data-bs-dismiss="alert"
、JavaScript 機能をトリガーする属性を追加します。<button>
すべてのデバイスで適切に動作するように、要素を一緒に使用してください。 - アラートを閉じるときにアラートをアニメーション化するには、
.fade
および.show
クラスを必ず追加してください。
ライブデモでこれを実際に見ることができます:
<div class="alert alert-warning alert-dismissible fade show" role="alert">
<strong>Holy guacamole!</strong> You should check in on some of those fields below.
<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
</div>
closed.bs.alert
イベント
をリッスンfocus()
し、ページ内の最も適切な場所にプログラムで設定する追加の JavaScript を含めることをお勧めします。通常はフォーカスを受け取らない非インタラクティブな要素にフォーカスを移動する予定がある場合は、必ず
tabindex="-1"
要素に追加してください。
CSS
変数
v5.2.0 で追加Bootstrap の進化する CSS 変数アプローチの一環として、.alert
リアルタイムのカスタマイズを強化するためにアラートでローカル CSS 変数が使用されるようになりました。CSS 変数の値は Sass を介して設定されるため、Sass のカスタマイズも引き続きサポートされます。
--#{$prefix}alert-bg: transparent;
--#{$prefix}alert-padding-x: #{$alert-padding-x};
--#{$prefix}alert-padding-y: #{$alert-padding-y};
--#{$prefix}alert-margin-bottom: #{$alert-margin-bottom};
--#{$prefix}alert-color: inherit;
--#{$prefix}alert-border-color: transparent;
--#{$prefix}alert-border: #{$alert-border-width} solid var(--#{$prefix}alert-border-color);
--#{$prefix}alert-border-radius: #{$alert-border-radius};
サス変数
$alert-padding-y: $spacer;
$alert-padding-x: $spacer;
$alert-margin-bottom: 1rem;
$alert-border-radius: $border-radius;
$alert-link-font-weight: $font-weight-bold;
$alert-border-width: $border-width;
$alert-bg-scale: -80%;
$alert-border-scale: -70%;
$alert-color-scale: 40%;
$alert-dismissible-padding-r: $alert-padding-x * 3; // 3x covers width of x plus default padding on either side
サスミックスイン
と組み合わせて使用し$theme-colors
て、アラートのコンテキスト修飾子クラスを作成します。
@mixin alert-variant($background, $border, $color) {
--#{$prefix}alert-color: #{$color};
--#{$prefix}alert-bg: #{$background};
--#{$prefix}alert-border-color: #{$border};
@if $enable-gradients {
background-image: var(--#{$prefix}gradient);
}
.alert-link {
color: shade-color($color, 20%);
}
}
サスループ
ミックスインで修飾子クラスを生成するループalert-variant()
。
// Generate contextual modifier classes for colorizing the alert.
@each $state, $value in $theme-colors {
$alert-background: shift-color($value, $alert-bg-scale);
$alert-border: shift-color($value, $alert-border-scale);
$alert-color: shift-color($value, $alert-color-scale);
@if (contrast-ratio($alert-background, $alert-color) < $min-contrast-ratio) {
$alert-color: mix($value, color-contrast($alert-background), abs($alert-color-scale));
}
.alert-#{$state} {
@include alert-variant($alert-background, $alert-border, $alert-color);
}
}
JavaScript の動作
初期化する
要素をアラートとして初期化する
const alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new bootstrap.Alert(element))
アラートを無視するという目的だけのために、JS API を介してコンポーネントを手動で初期化する必要はありません。を利用することでdata-bs-dismiss="alert"
、コンポーネントは自動的に初期化され、適切に破棄されます。
詳細については、トリガーのセクションを参照してください。
トリガー
以下に示すように、アラート内のdata
ボタンの属性を使用して却下を実現できます。
<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="Close"></button>
または、以下に示すように を使用して、アラートの外側のボタンでdata-bs-target
:
<button type="button" class="btn-close" data-bs-dismiss="alert" data-bs-target="#my-alert" aria-label="Close"></button>
アラートを閉じると、DOM から削除されることに注意してください。
メソッド
次の例のように、アラート コンストラクターを使用してアラート インスタンスを作成できます。
const bsAlert = new bootstrap.Alert('#myAlert')
これにより、アラートはdata-bs-dismiss="alert"
属性を持つ子孫要素のクリック イベントをリッスンします。(data-api の自動初期化を使用する場合は必要ありません。)
方法 | 説明 |
---|---|
close |
DOM からアラートを削除してアラートを閉じます。.fade およびクラスが要素に存在する場合.show 、アラートは削除される前にフェードアウトします。 |
dispose |
要素のアラートを破棄します。(DOM要素に格納されたデータを削除します) |
getInstance |
DOM 要素に関連付けられたアラート インスタンスを取得できる静的メソッド。例: bootstrap.Alert.getInstance(alert) . |
getOrCreateInstance |
DOM 要素に関連付けられたアラート インスタンスを返すか、初期化されていない場合に新しいアラート インスタンスを作成する静的メソッド。次のように使用できますbootstrap.Alert.getOrCreateInstance(element) 。 |
基本的な使い方:
const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')
alert.close()
イベント
Bootstrap のアラート プラグインは、アラート機能にフックするためのいくつかのイベントを公開します。
イベント | 説明 |
---|---|
close.bs.alert |
close インスタンス メソッドが呼び出されるとすぐに発生します。 |
closed.bs.alert |
アラートがクローズされ、CSS トランジションが完了したときに発生します。 |
const myAlert = document.getElementById('myAlert')
myAlert.addEventListener('closed.bs.alert', event => {
// do something, for instance, explicitly move focus to the most appropriate element,
// so it doesn't get lost/reset to the start of the page
// document.getElementById('...').focus()
})