アラート
利用可能な柔軟なアラートメッセージを利用して、一般的なユーザー操作に対するコンテキストフィードバックメッセージを提供します。
サンプル
アラートは任意の長さのテキストで使用でき、オプションで閉じるボタンを追加できます。適切なスタイルを設定するには、8つの必須のコンテキストクラス(例:.alert-success
)のいずれかを使用します。インラインでの非表示には、アラートのJavaScriptプラグインを使用します。
alert-variant()
Sassミックスインは非推奨になりました。アラートのバリアントは、SassループでCSS変数が上書きされるようになりました。<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 appendAlert = (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', () => {
appendAlert('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>
アイコン
同様に、flexboxユーティリティとBootstrapアイコンを使用して、アイコン付きのアラートを作成できます。アイコンとコンテンツによっては、追加のユーティリティまたはカスタムスタイルを追加する必要がある場合があります。
<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>
アラートに複数のアイコンが必要ですか?複数のBootstrapアイコンを使用し、次のようにローカルのSVGスプライトを作成して、同じアイコンを繰り返し簡単に参照することを検討してください。
<svg xmlns="http://www.w3.org/2000/svg" class="d-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
クラスを追加します。 - 閉じるボタンに、JavaScript機能をトリガーする
data-bs-dismiss="alert"
属性を追加します。すべてのデバイスで適切な動作のために、<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};
--#{$prefix}alert-link-color: inherit;
Sass変数
$alert-padding-y: $spacer;
$alert-padding-x: $spacer;
$alert-margin-bottom: 1rem;
$alert-border-radius: var(--#{$prefix}border-radius);
$alert-link-font-weight: $font-weight-bold;
$alert-border-width: var(--#{$prefix}border-width);
$alert-dismissible-padding-r: $alert-padding-x * 3; // 3x covers width of x plus default padding on either side
Sassミックスイン
v5.3.0で非推奨@mixin alert-variant($background, $border, $color) {
--#{$prefix}alert-color: #{$color};
--#{$prefix}alert-bg: #{$background};
--#{$prefix}alert-border-color: #{$border};
--#{$prefix}alert-link-color: #{shade-color($color, 20%)};
@if $enable-gradients {
background-image: var(--#{$prefix}gradient);
}
.alert-link {
color: var(--#{$prefix}alert-link-color);
}
}
Sassループ
CSS変数のオーバーライドを使用して、修飾子クラスを生成するループ。
// Generate contextual modifier classes for colorizing the alert
@each $state in map-keys($theme-colors) {
.alert-#{$state} {
--#{$prefix}alert-color: var(--#{$prefix}#{$state}-text-emphasis);
--#{$prefix}alert-bg: var(--#{$prefix}#{$state}-bg-subtle);
--#{$prefix}alert-border-color: var(--#{$prefix}#{$state}-border-subtle);
--#{$prefix}alert-link-color: var(--#{$prefix}#{$state}-text-emphasis);
}
}
JavaScriptの動作
初期化
要素をアラートとして初期化します
const alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new bootstrap.Alert(element))
アラートを非表示にするという唯一の目的のため、JS APIを使用してコンポーネントを手動で初期化する必要はありません。data-bs-dismiss="alert"
を利用することで、コンポーネントは自動的に初期化され、適切に非表示になります。
詳細については、トリガーのセクションを参照してください。
トリガー
非表示は、以下に示すように、アラート内のボタンのdata-bs-dismiss
属性を使用して実現できます
<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()
})