アラート(Alerts)
一掴みほどの利用可能な柔軟な警告メッセージを使用して、一般的なユーザーアクションに対するコンテキストフィードバックメッセージを提供。
※"v5.0.0"での変更はv5.0.0-alpha版、v5.0.0-beta版での変更も含みます。
※"v5.3.0"での変更はv5.3.0-alpha版での変更も含みます。
アラートの設定(Examples)v5.2.0デザイン変更
アラートは任意の長さのテキストとオプションの閉じるボタンで利用できる。適切なスタイルを設定するには、必要な8つの色クラス(例:.alert-success
)のいずれかを使用。インラインで閉じる場合、アラートJavaScriptプラグインを使用。
alert-variant()
は非推奨になった。
色の種類
.alert-primary
.alert-secondary
.alert-success
.alert-danger
.alert-warning
.alert-info
.alert-light
.alert-dark
設定例
<div class="alert alert-primary" role="alert"><strong>アラート</strong> - チェックして下さい!</div>
primary:.alert.alert-primary[role=alert]
secondary:.alert.asecondarylert-secondary[role=alert]
success:.alert.alert-success[role=alert]
danger:.alert.alert-danger[role=alert]
warning:.alert.alert-warning[role=alert]
info:.alert.alert-info[role=alert]
light:.alert.alert-light[role=alert]
dark:.alert.alert-dark[role=alert]
【設定】
.alert.alert-{themecolor}
(.alert-{themecolor}
は上記の「色の種類」から選択、.alert
単独での使用はできない){themecolor}
は、primary
,secondary
,success
,danger
,warning
,info
,light
,dark
のいずれかを選択
【アクセシビリティの設定】
.alert.alert-{themecolor}
に、role="alert"
属性(支援技術にアラート(警告情報)の役割を伝える)を入れる
【変更履歴】
- 【v5.2.0】
border-radius
の値を調整したので、若干丸みを帯びたデザインに変更
.visually-hidden
クラスで非表示にした追加テキストなどの代替手段を入れるように心がけて下さい。
ライブの実例(Live example)v5.1.0新設、v5.3.0Javascriptの設定変更
下のボタンをクリックしてアラートを表示し(開始するにはインラインスタイルで非表示)、組み込みの閉じるボタンでアラートを閉じる(そして破棄)。
見本
設定例
HTML<div id="liveAlertPlaceholder"></div>
<button type="button" class="btn btn-primary" id="liveAlertBtn">ライブでアラートを表示</button>
次のJavaScriptを使用して、ライブでアラートデモを起動。
Bootstrap5.3.0~の設定例 緑背景が5.2.0以降の変更箇所
JavaScriptconst 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="閉じる"></button>',
'</div>'
].join('')
alertPlaceholder.append(wrapper)
}
const alertTrigger = document.getElementById('liveAlertBtn')
if (alertTrigger) {
alertTrigger.addEventListener('click', () => {
appendAlert('いいね!このアラートメッセージを起動しました。', 'success')
})
}
※Bootstrap5.1.xの設定例 赤背景が5.2.0以降の変更箇所
JavaScriptvar alertPlaceholder = document.getElementById('liveAlertPlaceholder')
var alertTrigger = document.getElementById('liveAlertBtn')
function alert(message, type) {
var wrapper = document.createElement('div')
wrapper.innerHTML = '<div class="alert alert-' + type + ' alert-dismissible" role="alert">' + message + '<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="閉じる"></button></div>'
alertPlaceholder.append(wrapper)
}
if (alertTrigger) {
alertTrigger.addEventListener('click', function () {
alert('いいね!このアラートメッセージを起動しました。', 'success')
})
}
【変更履歴】
- 【v5.2.0】
- JavaScriptの記述をES6(ES2015)に変更
- 【v5.3.0】
const alertTrigger
の位置を変更alert()
⇒appendAlert()
アラート内のリンクの色(Link color)
.alert-link
ユーティリティ・クラスを使用すると、アラート内の色付きリンクが手早く表示できる。
見本
設定例
<div class="alert alert-primary" role="alert"><strong>太字!</strong> <a href="#" class="alert-link">リンク文字</a> 普通の文字</div>
【設定】
.alert.alert-{themecolor}
>a.alert-link
追加コンテンツ(Additional content)
アラートには、見出し、段落、仕切り線などの追加のHTML要素も入れられる。
見本
よくやった!
ええ、あなたはこの重要な警告メッセージを正常に読むことができます。このサンプルテキストは、少し長く実行されるため、アラート内の空白がこの種のコンテンツでどのように動作するかを確認できます。
必要なときはいつでもマージンユーティリティを使用して、素敵に整えて下さい。
設定例
<div class="alert alert-success" role="alert">
<h4 class="alert-heading">よくやった!</h4>
<p>ええ、あなたはこの重要な警告メッセージを正常に読むことができます。このサンプルテキストは、少し長く実行されるため、アラート内の空白がこの種のコンテンツでどのように動作するかを確認できます。</p>
<hr>
<p class="mb-0">必要なときはいつでもマージンユーティリティを使用して、素敵に整えて下さい。</p>
</div>
【設定】
- アラート内に見出し
<h*>
、段落<p>
、水平線<hr>
などの追加のHTML要素を入れる(.alert-heading
や.m{sides}-{size}
なども併用可)
アイコン付き(Icons)v5.0.0新設、v5.3.1設定変更
同様に、flexboxユーティリティとBootstrap Iconsを使用して、アイコン付きのアラートが作成できる。アイコンとコンテンツによっては、ユーティリティやカスタムスタイルの追加もできる。
1.単独でアイコンを使用する場合 v5.2.0設定変更
見本
Bootstrap5.2.0~の設定例 緑背景が5.2.0での変更箇所
<div class="alert alert-primary d-flex align-items-center" role="alert">
<svg xmlns="http://www.w3.org/2000/svg" width="1rem" height="1rem" fill="currentColor" class="bi bi-exclamation-triangle-fill flex-shrink-0 me-2" viewBox="0 0 16 16" role="img" aria-label="警告:">
<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>
アイコン付きのアラートの例
</div>
</div>
※Bootstrap5.1.xの設定例 赤背景が5.2.0での変更箇所
<div class="alert alert-primary d-flex align-items-center" role="alert">
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="currentColor" class="bi bi-exclamation-triangle-fill flex-shrink-0 me-2" viewBox="0 0 16 16" role="img" aria-label="警告:">
<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>
アイコン付きのアラートの例
</div>
</div>
2.アイコンを繰り返し使用する場合 v5.3.1設定変更
アラートに複数のアイコンが必要なら、同じアイコンを繰り返し簡単に参照できるようにより多くのBootstrap Iconsを使用してローカルSVGスプライトを作成する。
見本
Bootstrap5.3.1~の設定例 緑背景が5.2.0以降の変更箇所
<!-- アイコンの設定 -->
<svg xmlns="http://www.w3.org/2000/svg" class="d-none">
<symbol id="check-circle-fill" fill="currentColor" 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" fill="currentColor" 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" fill="currentColor" 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" width="1rem" height="1rem" role="img" aria-label="情報:"><use xlink:href="#info-fill"/></svg>
<div>
アイコン付きのアラートの例
</div>
</div>
<div class="alert alert-success d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="1rem" height="1rem" role="img" aria-label="成功:"><use xlink:href="#check-circle-fill"/></svg>
<div>
アイコン付きの成功アラートの例
</div>
</div>
<div class="alert alert-warning d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="1rem" height="1rem" role="img" aria-label="警告:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
アイコン付きの警告アラートの例
</div>
</div>
<div class="alert alert-danger d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="1rem" height="1rem" role="img" aria-label="危険:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
アイコン付きの危険アラートの例
</div>
</div>
※Bootstrap5.1.xの設定例 赤背景が5.2.0以降の変更箇所
<!-- アイコンの設定 -->
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
...
</svg>
<div class="alert alert-primary d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="情報:"><use xlink:href="#info-fill"/></svg>
<div>
アイコン付きのアラートの例
</div>
</div>
<div class="alert alert-success d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="成功:"><use xlink:href="#check-circle-fill"/></svg>
<div>
アイコン付きの成功アラートの例
</div>
</div>
<div class="alert alert-warning d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="警告:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
アイコン付きの警告アラートの例
</div>
</div>
<div class="alert alert-danger d-flex align-items-center" role="alert">
<svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="危険:"><use xlink:href="#exclamation-triangle-fill"/></svg>
<div>
アイコン付きの危険アラートの例
</div>
</div>
【設定】
- Bootstrap Iconsなどを使用してアラートにアイコンを入れることが可能
【変更履歴】
- 【v5.2.0】
- アイコンの
width
とheight
を24
⇒1rem
に変更
- アイコンの
- 【v5.3.1】
- アイコンの設定:
svg[style="display: none;"]
⇒svg.d-none
- アイコンの設定:
メッセージを閉じるボタン(Dismissing)v5.0.0-beta1設定変更
アラートJavaScriptプラグインを使用すると、アラートをすべて閉じることができます。方法は次のとおり:
- アラートプラグインかコンパイル済のBootstrapのJavaScriptファイルを読み込む。
- 閉じるボタンと
.alert-dismissible
クラスを追加。これにより、アラートの行末側に余白が追加され、.btn-close
ボタンが配置される。 - 閉じるボタンで、
data-bs-dismiss="alert"
属性を追加。これにより、JavaScript機能が起動される。すべてのデバイスで適切な動作をさせるには、必ず<button>
要素をご使用下さい。 - アラートを閉じるときにアラートをアニメーション化するには、必ず
.fade
と.show
のクラスを追加して下さい。
以下の見本でこれを見られる。
※実例としてモーダルを利用してアラートを表示する方法をモーダルでアラート表示に掲載。
見本
Bootstrap5.xの設定例 緑背景が変更箇所
<div class="alert alert-warning alert-dismissible fade show" role="alert">
<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="閉じる"></button>
<strong>注意!</strong> このアラートはあなたの注意が必要です。
</div>
※
.alert-primary
の部分はお好みのアラートカラーを選んで下さい※Bootstrap4.xの設定例 赤背景が変更箇所
<div class="alert alert-warning alert-dismissible fade show" role="alert">
<strong>注意!</strong> このアラートはあなたの注意が必要です。
<button type="button" class="close" data-dismiss="alert" aria-label="閉じる">
<span aria-hidden="true">×</span>
</button>
</div>
【設定】
.alert.alert-{themecolor}.alert-dismissible[role="alert"]
> {《アラート文》 +button.btn-close
《閉じるボタン》}- プラグインを使ってアラートを閉じるため
button.btn-close
にdata-bs-dismiss="alert"
を入れる - アイコンボタンをフェードインで閉じるためには
.alert.alert-{themecolor}.alert-dismissible
に.fade.show
を追加
【アクセシビリティの設定】
- モーダルを閉じるボタンとなる
button.btn-close
に、aria-label
属性(ビジュアルで目的を表現する要素に対するラベル付け)を入れる
【変更履歴】
- 【v5.0.0-alpha2】
- 閉じるボタンの設定の変更(
.close
⇒.btn-close
、span[aria-hidden="true"]
>×
が不要に)
- 閉じるボタンの設定の変更(
- 【v5.0.0-beta1】
data-
属性に名前空間bs-
を追加[data-dismiss="alert"]
⇒[data-bs-dismiss="alert"]
closed.bs.alert
イベントを処理し、プログラムでページ内の最も適切な場所に focus()
を設定する追加のJavaScriptを含めることを推奨。通常はフォーカスを受け取らない非インタラクティブ要素にフォーカスを移動する場合は、要素に tabindex="-1"
を追加して下さい。
CSS v5.0.0-beta3追加、v5.2.0Sassから名称変更
CSS変数(Variables)v5.2.0設定移行
Bootstrapの進化するCSS変数アプローチの一環として、アラートは、リアルタイムのカスタマイズを強化するために、.alert
でローカルCSS変数を使用するようにした。CSS変数の値はSassを経由して設定されるため、Sassのカスタマイズも引き続きサポートされる。
デフォルトの設定
scss/_alert.scss 内 alert-css-vars の設定--#{$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};
Sass変数(Sass variables)v5.2.0変数から名称変更
デフォルトの設定
scss/_variables.scss 内 alert-variables の設定$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は、xの幅に加えて、両側のデフォルトのパディングをカバー
Sassミックスイン(Sass mixins)v5.2.0バリエーションmixinから名称変更 v5.3.0非推奨
デフォルトの設定
scss/mixins/_alert.scss 内 alert-variant-mixin の設定@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ループ(Sass loops)v5.2.0ループから名称変更
CSS変数を上書きして修飾子クラスを生成するループ。
デフォルトの設定
scss/_alert.scss 内 alert-modifiers の設定// アラートを色付けするためのコンテキスト修飾子クラスを生成
@each $state in map-keys($theme-colors) {
.alert-#{$state} {
--#{$prefix}alert-color: var(--#{$prefix}#{$state}-text);
--#{$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);
}
}
JavaScriptの動作(JavaScript behavior)
初期化(Initialize)v5.1.0追加、v5.2.0設定変更
要素をアラートとして初期化。
Bootstrap5.2.0~の設定例 緑背景が5.2.0での変更箇所
JavaScriptconst alertList = document.querySelectorAll('.alert')
const alerts = [...alertList].map(element => new bootstrap.Alert(element))
※Bootstrap5.1.xの設定例 赤背景が5.2.0での変更箇所
JavaScriptvar alertList = document.querySelectorAll('.alert')
var alerts = [].slice.call(alertList).map(function (element) {
return new bootstrap.Alert(element)
})
※Bootstrap4.xの設定例
JavaScript$('.alert').alert()
アラートを閉じるという唯一の目的のために、JSAPIを介してコンポーネントを手動で初期化する必要はない。data-bs-dismiss="alert"
を利用することで、コンポーネントは自動的に初期化され、適切に破棄される。
詳細については、トリガーの項目に記載。
トリガー(Triggers)
アラートを閉じるには、下記のようにアラート内のボタンの data
属性を使用して実行できる:
設定例
HTML<button type="button" class="btn-close" data-bs-dismiss="alert" aria-label="閉じる">
</button>
または、下記のように追加の data-bs-target
を使用してアラートの外側のボタンに表示できる:
設定例
<button type="button" class="btn-close" data-bs-dismiss="alert" data-bs-target="#my-alert" aria-label="閉じる"></button>
アラートを閉じると、DOMから削除されるので注意。
【変更履歴】
- 【v5.0.0-alpha1】
- JavaScriptの記述をjQueryに依存しない方法に変更
- 【v5.0.0-alpha2】
- 閉じるボタンの設定の変更(
.close
⇒.btn-close
、span[aria-hidden="true"]
>×
が不要に)
- 閉じるボタンの設定の変更(
- 【v5.0.0-beta1】
data-
属性に名前空間bs-
を追加[data-dismiss="alert"]
⇒[data-bs-dismiss="alert"]
- 【v5.2.0】
- JavaScriptの記述をES6(ES2015)に変更
メソッド(Methods)v5.0.0-alpha1設定変更、v5.0.2メソッド追加
アラート・コンストラクタを使用してアラート・インスタンスが作成できる。以下に例を表示:
設定例 v5.2.0変更
JavaScriptconst bsAlert = new bootstrap.Alert('#myAlert')
これにより、data-bs-dismiss="alert"
属性を持つ子孫要素上でクリック・イベントをアラートに従わせる(data-apiの自動初期化を使用する場合は不要)。
メソッド | 説明 |
---|---|
close |
DOMからアラートを削除して閉じる。.fade と .show クラスが要素上にある場合、アラートはそれが削除される前にフェードアウトする。 |
dispose |
要素のアラートを破棄(DOM要素に保存されているデータを削除)。 |
getInstance v5.0.0-alpha1追加 |
DOM要素に関連付けられたアラート・インスタンスを取得できる静的メソッドで、次のように使用可能:bootstrap.Alert.getInstance(element) |
getOrCreateInstance v5.0.2追加 |
DOM要素に関連付けられたアラート・インスタンスを取得したり、初期化されていない場合に新しいインスタンスを作成したりできる静的メソッド。次のように使用可能:bootstrap.Alert.getOrCreateInstance(element) |
基本的な使い方
JavaScriptconst alert = bootstrap.Alert.getOrCreateInstance('#myAlert')
alert.close()
【変更履歴】
- 【v5.0.0-alpha1】
$().alert('xxx')
⇒alert.xxx()
getInstance
メソッドが追加
- 【v5.0.2】
getOrCreateInstance
メソッドが追加
- 【v5.2.0】
- JavaScriptの記述をES6(ES2015)に変更
イベント(Events)
Bootstrapのアラートプラグインは、アラート機能に接続するためにいくつかのイベントを公開する。
イベントタイプ | 説明 |
---|---|
close.bs.alert |
close のインスタンス・メソッドが呼び出されると直ちに発動。 |
closed.bs.alert |
アラートが閉じられると発動(完全にCSS遷移が完了するまで待機)。 |
使用例 v5.2.0設定変更
JavaScriptconst myAlert = document.getElementById('myAlert')
myAlert.addEventListener('closed.bs.alert', event => {
// 何かをする、たとえば、フォーカスを最も適切な要素に明示的に移動する、
// そのため、ページの先頭に失われたりリセットされたりすることはない
// document.getElementById('...').focus()
})