リストグループ（List group）

基本のリストグループ（Basic example）

最も基本的なリストグループは、リストアイテムと適切なクラスを持つ順不同のリスト。それに続くオプションや必要に応じて独自のCSSを使って構築。

見本

設定例

コピー<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item">アイテム1</li>
  <li class="list-group-item">アイテム2</li>
  <li class="list-group-item">アイテム3</li>
</ul>

 

アクティブなアイテム（Active items）v5.0.0-alpha1設定変更

.active を .list-group-item に追加すると、現在のアクティブな選択を示す。

見本

Bootstrap5.xの設定例 緑背景が変更箇所

コピー<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item active" aria-current="true">アイテム1</li>
  <li class="list-group-item">アイテム2</li>
  <li class="list-group-item">アイテム3</li>
</ul>

※Bootstrap4.xの設定例 赤背景が変更箇所

<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item active">アイテム1</li>
  <li class="list-group-item">アイテム2</li>
  <li class="list-group-item">アイテム3</li>
</ul>

 

無効のアイテム（Disabled items）

.disabled を .list-group-item に追加すると、無効に見えるようになる。.disabled を持つ要素の中には、（リンクなど）クリックイベントを完全に無効にするカスタムJavaScriptが必要な場合がある。

見本

設定例

コピー<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item disabled" aria-disabled="true">アイテム1</li>
  <li class="list-group-item">アイテム2</li>
  <li class="list-group-item">アイテム3</li>
</ul>

 

リンク付き＆ボタンによるリストグループ（Links and buttons）

.list-group-item-action を追加することで、ホバー、無効、アクティブ状態のアクション可能なリストグループアイテムを作成するには、<a> や <button> を使用する。これらの擬似クラスを分離して、非対話型要素（<li> や <div> など）で作成されたリストグループがクリックやタップ機能を提供しないようにする。

ここでは、デフォルトの .btn クラスは使用しないこと。

1. リンク付きリストグループ v5.1.1設定変更

見本

Bootstrap5.1.1～の設定例 緑背景が変更箇所

コピー<div class="list-group" style="max-width: 400px;">
  <a href="#" class="list-group-item list-group-item-action active" aria-current="true">現在のリンクアイテム</a>
  <a href="#" class="list-group-item list-group-item-action">リンクアイテム2</a>
  <a href="#" class="list-group-item list-group-item-action">リンクアイテム3</a>
  <a class="list-group-item list-group-item-action disabled">無効のリンクアイテム</a>
</div>

※Bootstrap5.1.0の設定例 赤背景が変更箇所

<div class="list-group" style="max-width: 400px;">
  <a href="#" class="list-group-item list-group-item-action active" aria-current="true">現在のリンクアイテム</a>
  <a href="#" class="list-group-item list-group-item-action">リンクアイテム2</a>
  <a href="#" class="list-group-item list-group-item-action">リンクアイテム3</a>
  <a href="#" class="list-group-item list-group-item-action disabled" tabindex="-1" aria-disabled="true">無効のリンクアイテム</a>
</div>

2. ボタンによるリストグループ

<button> では、.disabled クラスの代わりに disabled 属性も使用できる。悲しいことに、<a> は disabled 属性をサポートしていない。

見本

Bootstrap5.xの設定例 緑背景が変更箇所

コピー<div class="list-group" style="max-width: 400px;">
  <button type="button" class="list-group-item list-group-item-action active" aria-current="true">現在のボタンアイテム</button>
  <button type="button" class="list-group-item list-group-item-action">ボタンアイテム2</button>
  <button type="button" class="list-group-item list-group-item-action">ボタンアイテム3</button>
  <button type="button" class="list-group-item list-group-item-action" disabled>無効のボタンアイテム</button>
</div>

 

外枠なし（Flush）

.list-group-flush を追加すると、親コンテナ（カードなど）内でリストグループアイテムを端から端まで描画するために、いくつかの枠線と丸みのある角を削除できる。

見本

設定例

コピー<ul class="list-group list-group-flush" style="max-width: 400px;">
  <li class="list-group-item">アイテム1</li>
  <li class="list-group-item">アイテム2</li>
  <li class="list-group-item">アイテム3</li>
</ul>

 

番号付き（Numbered）v5.0.0-beta3新設

.list-group-numbered 修飾子クラスを追加（オプションで <ol> 要素を使用）して、番号付きリストグループアイテムを再定義する。番号は（<ol> のデフォルトのブラウザスタイルではなく）CSSを経由して生成され、リストグループアイテム内での配置を改善し、カスタマイズを改善する。

番号は、<ol> の counter-reset によって生成され、<li> の ::before 疑似要素で counter-increment と content を使用してスタイル設定と配置をする。

見本

設定例

コピー<ol class="list-group list-group-numbered" style="max-width: 400px;">
  <li class="list-group-item">アイテム</li>
  <li class="list-group-item">アイテム</li>
  <li class="list-group-item">アイテム</li>
</ol>

これらはカスタムコンテンツでもうまく機能。

見本

設定例

コピー<ol class="list-group list-group-numbered" style="max-width: 400px;">
  <li class="list-group-item d-flex justify-content-between align-items-start">
    <div class="ms-2 me-auto">
      <div class="fw-bold">小見出し</div>
      アイテムのコンテンツ
    </div>
    <span class="badge bg-primary rounded-pill">14</span>
  </li>
  <li class="list-group-item d-flex justify-content-between align-items-start">
    <div class="ms-2 me-auto">
      <div class="fw-bold">小見出し</div>
      アイテムのコンテンツ
    </div>
    <span class="badge bg-primary rounded-pill">14</span>
  </li>
  <li class="list-group-item d-flex justify-content-between align-items-start">
    <div class="ms-2 me-auto">
      <div class="fw-bold">小見出し</div>
      アイテムのコンテンツ
    </div>
    <span class="badge bg-primary rounded-pill">14</span>
  </li>
</ol>

 

水平スタイル（Horizontal）v5.0.0-alpha1クラス追加

全てのブレークポイントにわたってリストグループアイテムのレイアウトを縦並びから横並びに変更するには .list-group-horizontal を追加する。あるいは、レスポンシブ形式の .list-group-horizontal-{sm|md|lg|xl|xxl} を選択して、そのブレークポイントの min-width で始まるリストグループを水平にする。今のところ水平リストグループは枠なしリストグループと組み合わせることは不可。

ヒント：横並びの場合、等幅のリストグループアイテムが必要なら、各リストグループアイテム（.list-group-item）に .flex-fill を追加すること。

定義済クラスの種類

設定例

全てのブレークポイントコピー<ul class="list-group list-group-horizontal">
  <li class="list-group-item">アイテム1</li>
  <li class="list-group-item">アイテム2（長め）</li>
  <li class="list-group-item">アイテム3</li>
</ul>

特定のブレークポイントコピー<ul class="list-group list-group-horizontal-**">
  <li class="list-group-item">アイテム1</li>
  <li class="list-group-item">アイテム2（長め）</li>
  <li class="list-group-item">アイテム3</li>
</ul>

等幅のリストグループコピー<ul class="list-group list-group-horizontal">
  <li class="list-group-item flex-fill">アイテム1</li>
  <li class="list-group-item flex-fill">アイテム2（長め）</li>
  <li class="list-group-item flex-fill">アイテム3</li>
</ul>

表示の範囲

 

リストグループの背景色（Contextual classes）

背景色のクラスを使用して、状態が反映された背景と色でリストアイテムのスタイルを設定。

背景色の種類

設定例

コピー<ul class="list-group" style="max-width: 500px;">
  <li class="list-group-item list-group-item-primary">アイテム</li>
  ...
</ul>

背景色のクラスも .list-group-item-action で動作。ここではホバースタイルも追加されているので注意。.active 状態もサポートし、背景色のついたリストグループアイテムのアクティブな選択を示すためにそれを適用。

背景色の種類

設定例

コピー<div class="list-group" style="max-width: 500px;">
  <a href="#" class="list-group-item list-group-item-action list-group-item-primary active" aria-current="true">アクティブ化</a>
  <a href="#" class="list-group-item list-group-item-action list-group-item-primary">アイテム</a>
  ...
</div>

 

枠線の色 ※裏技

各リストの枠線の色を変える。

見本

設定例

コピー<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item border-warning">アイテム1</li>
  <li class="list-group-item border-info">アイテム2</li>
  <li class="list-group-item border-danger">アイテム3</li>
</ul>

 

バッジ付きリストグループ（With badges）

いくつかのユーティリティの助けを借りて、未読の数、活動などを表示するために、リストグループアイテムにバッジを追加。

見本

設定例

コピー<ul class="list-group" style="max-width: 400px;">
  <li class="list-group-item d-flex justify-content-between align-items-center">
    リストアイテム1
    <span class="badge bg-primary rounded-pill">14</span>
  </li>
  <li class="list-group-item d-flex justify-content-between align-items-center">
    リストアイテム2
    <span class="badge bg-primary rounded-pill">2</span>
  </li>
  <li class="list-group-item d-flex justify-content-between align-items-center">
    リストアイテム3
    <span class="badge bg-primary rounded-pill">1</span>
  </li>
</ul>

 

ヘッダありリンク付きリストグループ（Custom content）

Flexユーティリティの助けを借りて、下記のようなリンクリストグループの場合でも、ほぼすべてのHTMLを追加すること。

見本

Bootstrap5.xの設定例 緑背景が変更箇所

コピー<div class="list-group" style="max-width: 400px;">
  <a href="#" class="list-group-item list-group-item-action active" aria-current="true">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">リストグループ1のヘッダ</h5>
      <small>3日前</small>
    </div>
    <p class="mb-1">段落内のプレースホルダコンテンツ。</p>
    <small>サブコンテンツ</small>
  </a>
  <a href="#" class="list-group-item list-group-item-action">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">リストグループ2のヘッダ</h5>
      <small>3日前</small>
    </div>
    <p class="mb-1">段落内のプレースホルダコンテンツ。</p>
    <small>サブコンテンツ</small>
  </a>
  <a href="#" class="list-group-item list-group-item-action">
    <div class="d-flex w-100 justify-content-between">
      <h5 class="mb-1">リストグループ3のヘッダ</h5>
      <small>3日前</small>
    </div>
    <p class="mb-1">段落内のプレースホルダコンテンツ。</p>
    <small>サブコンテンツ</small>
  </a>
</div>

 

チェックボックスとラジオボタン（Checkboxes and radios）v5.0.0-alpha1新設、v5.0.0-beta1設定変更

Bootstrapのチェックボックスとラジオボタンをリストグループアイテム内に配置し、必要に応じてカスタマイズ。<label> はなくても使用できるが、アクセシビリティのために aria-label 属性と value 値は入れること。

1. 基本の設定

見本

設定例 緑背景がv5.0.0-beta1での変更箇所

コピー<ul class="list-group">
  <li class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="" aria-label="...">
    チェックボックス1
  </li>
  <li class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="" aria-label="...">
    チェックボックス2
  </li>
  <li class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="" aria-label="...">
    チェックボックス3
  </li>
  <li class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="" aria-label="...">
    チェックボックス4
  </li>
  <li class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="" aria-label="...">
    チェックボックス5
  </li>
</ul>

2. ラベル付き

また、大きなヒットエリアの .list-group-item として <label> が必要な場合は、それも設定できる。

見本

設定例 緑背景がv5.0.0-beta1での変更箇所

コピー<div class="list-group">
  <label class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="">
    チェックボックス1
  </label>
  <label class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="">
    チェックボックス2
  </label>
  <label class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="">
    チェックボックス3
  </label>
  <label class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="">
    チェックボックス4
  </label>
  <label class="list-group-item">
    <input type="checkbox" class="form-check-input me-1" value="">
    チェックボックス5
  </label>
</div>

 

Sass v5.0.0-beta3追加

変数（Variables）

デフォルトの設定

scss/_variables.scss 内 list-group-variables の設定$list-group-color:                  $gray-900;
$list-group-bg:                     $white;
$list-group-border-color:           rgba($black, .125);
$list-group-border-width:           $border-width;
$list-group-border-radius:          $border-radius;

$list-group-item-padding-y:         $spacer / 2;
$list-group-item-padding-x:         $spacer;
$list-group-item-bg-scale:          -80%;
$list-group-item-color-scale:       40%;

$list-group-hover-bg:               $gray-100;
$list-group-active-color:           $component-active-color;
$list-group-active-bg:              $component-active-bg;
$list-group-active-border-color:    $list-group-active-bg;

$list-group-disabled-color:         $gray-600;
$list-group-disabled-bg:            $list-group-bg;

$list-group-action-color:           $gray-700;
$list-group-action-hover-color:     $list-group-action-color;

$list-group-action-active-color:    $body-color;
$list-group-action-active-bg:       $gray-200;

mixin（Mixins）

$theme-colors と組み合わせて使用し、.list-group-items のカラーバリエーションクラスを生成。

デフォルトの設定

scss/mixins/_list-group.scss 内 list-group-modifiers の設定@mixin list-group-item-variant($state, $background, $color) {
  .list-group-item-#{$state} {
    color: $color;
    background-color: $background;

    &.list-group-item-action {
      &:hover,
      &:focus {
        color: $color;
        background-color: shade-color($background, 10%);
      }

      &.active {
        color: $white;
        background-color: $color;
        border-color: $color;
      }
    }
  }
}

ループ（Loop）

list-group-item-variant() mixinを使用して修飾子クラスを生成するループ。

デフォルトの設定

scss/_list-group.scss 内 list-group-modifiers の設定// リストグループのカラーバリエーションを一覧表示
//
// 修飾子クラスを追加して、個々のアイテムのテキストと背景色を変更
// 組織的には、これは `：hover` 状態の後に来る必要がある

@each $state, $value in $theme-colors {
  $list-group-variant-bg: shift-color($value, $list-group-item-bg-scale);
  $list-group-variant-color: shift-color($value, $list-group-item-color-scale);
  @if (contrast-ratio($list-group-variant-bg, $list-group-variant-color) < $min-contrast-ratio) {
    $list-group-variant-color: mix($value, color-contrast($list-group-variant-bg), abs($list-group-item-color-scale));
  }

  @include list-group-item-variant($state, $list-group-variant-bg, $list-group-variant-color);
}

 

JavaScriptの動作（JavaScript behavior）v5.0.0-beta1設定変更

個別かコンパイルされた bootstrap.js ファイルを通じてタブJavaScriptプラグインを使用して、リストグループを拡張して、ローカルコンテンツのタブ切替パネルを作成。

見本

Bootstrap5.xの設定例 緑背景が変更箇所

コピー<div class="row">
  <div class="col-4">
    <div class="list-group" id="list-tab" role="tablist">
      <a class="list-group-item list-group-item-action active" aria-current="true" id="list-home-list" data-bs-toggle="list" href="#list-home" role="tab" aria-controls="list-home">ホーム</a>
      <a class="list-group-item list-group-item-action" id="list-profile-list" data-bs-toggle="list" href="#list-profile" role="tab" aria-controls="list-profile">プロフィール</a>
      <a class="list-group-item list-group-item-action" id="list-messages-list" data-bs-toggle="list" href="#list-messages" role="tab" aria-controls="list-messages">メッセージ</a>
      <a class="list-group-item list-group-item-action" id="list-settings-list" data-bs-toggle="list" href="#list-settings" role="tab" aria-controls="list-settings">セッティング</a>
    </div>
  </div>
  <div class="col-8">
    <div class="tab-content" id="nav-tabContent">
      <div class="tab-pane fade show active" id="list-home" role="tabpanel" aria-labelledby="list-home-list">「ホーム」に関連する段落のプレースホルダコンテンツ。...</div>
      <div class="tab-pane fade" id="list-profile" role="tabpanel" aria-labelledby="list-profile-list">「プロフィール」に関連する段落のプレースホルダコンテンツ。...</div>
      <div class="tab-pane fade" id="list-messages" role="tabpanel" aria-labelledby="list-messages-list">「メッセージ」に関連する段落のプレースホルダコンテンツ。...</div>
      <div class="tab-pane fade" id="list-settings" role="tabpanel" aria-labelledby="list-settings-list">「セッティング」に関連する段落のプレースホルダコンテンツ。...</div>
    </div>
  </div>
</div>

データ属性の使用（Using data attributes）

単に data-bs-toggle="list" を指定するだけで、要素にJavaScriptを書くことなく、リストグループのナビゲーションを有効にできる。これらのデータ属性は、.list-group-item で使用。

設定例

コピー<div role="tabpanel">
  <!-- リストグループ -->
  <div class="list-group" id="myList" role="tablist">
    <a class="list-group-item list-group-item-action active" aria-current="true" data-bs-toggle="list" href="#home" role="tab">ホーム</a>
    <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#profile" role="tab">プロフィール</a>
    <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#messages" role="tab">メッセージ</a>
    <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#settings" role="tab">セッティング</a>
  </div>

  <!-- パネル部分 -->
  <div class="tab-content">
    <div class="tab-pane active" id="home" role="tabpanel">...</div>
    <div class="tab-pane" id="profile" role="tabpanel">...</div>
    <div class="tab-pane" id="messages" role="tabpanel">...</div>
    <div class="tab-pane" id="settings" role="tabpanel">...</div>
  </div>
</div>

JavaScript経由で（Via JavaScript）v5.0.0-alpha1設定変更

JavaScriptを使用してタブ切替可能なリストアイテムを有効にする（各リストアイテムは個別に有効にする必要あり）：

Bootstrap5.xの設定例

JavaScriptコピーvar triggerTabList = [].slice.call(document.querySelectorAll('#myList a'))
triggerTabList.forEach(function (triggerEl) {
  var tabTrigger = new bootstrap.Tab(triggerEl)

  triggerEl.addEventListener('click', function (event) {
    event.preventDefault()
    tabTrigger.show()
  })
})

※Bootstrap4.xの設定例

JavaScript$('#myList a').on('click',function (event) {
  event.preventDefault()
  $(this).tab('show')
})

いくつかの方法で個々のリストアイテムをアクティブにできる：

Bootstrap5.xの設定例

JavaScriptコピーvar triggerEl = document.querySelector('#myList a[href="#profile"]')
bootstrap.Tab.getInstance(triggerEl).show() // リストアイテム名で選択

var triggerFirstTabEl = document.querySelector('#myList li:first-child a')
bootstrap.Tab.getInstance(triggerFirstTabEl).show() // 最初のリストアイテムを選択

※Bootstrap4.xの設定例

JavaScript$('#myList a[href="#profile"]').tab('show') // リストアイテム名で選択

$('#myList a:first-child').tab('show') // 最初のリストアイテムを選択

フェード効果（Fade effect）

タブパネルをフェードインさせるには、各 .tab-pane に .fade を追加。最初のタブパネルには、最初のコンテンツを表示させるために .show が必要。

メソッド（Methods）v5.0.0-alpha1設定変更、追加

コンストラクタ（constructor）

リストアイテム要素とコンテンツコンテナをアクティブにする。タブは、DOM内のコンテナの接点をターゲットとする data-bs-target か href が必要。

HTML<div class="list-group" id="myList" role="tablist">
  <a class="list-group-item list-group-item-action active" aria-current="true" data-bs-toggle="list" href="#home" role="tab">ホーム</a>
  <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#profile" role="tab">プロフィール</a>
  <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#messages" role="tab">メッセージ</a>
  <a class="list-group-item list-group-item-action" data-bs-toggle="list" href="#settings" role="tab">セッティング</a>
</div>

<div class="tab-content">
  <div class="tab-pane active" id="home" role="tabpanel">...</div>
  <div class="tab-pane" id="profile" role="tabpanel">...</div>
  <div class="tab-pane" id="messages" role="tabpanel">...</div>
  <div class="tab-pane" id="settings" role="tabpanel">...</div>
</div>

Bootstrap5.xの設定例

JavaScriptコピーvar firstTabEl = document.querySelector('#myList a:last-child')
var firstTab = new bootstrap.Tab(firstTabEl)

firstTab.show()

※Bootstrap4.xの設定例

JavaScript<script>
  $(function () {
    $('#myList a:last-child').tab('show')
  })
</script>

show

指定されたリストアイテムを選択し、関連するコンテンツを表示。その前に選択された他のリストアイテムは選択解除され、関連するコンテンツは非表示になる。タブパネル区画が実際に表示される前に（例えば、shown.bs.tab イベント発動前）に呼び出し元に戻る。

JavaScript  var someListItemEl = document.querySelector('#someListItem')
  var tab = new bootstrap.Tab(someListItemEl)

  tab.show()

dispose

要素のタブを破棄。

getInstance v5.0.0-alpha1追加

DOM要素に関連付けられたタブ・インスタンスを取得できる静的メソッド

JavaScriptコピーvar triggerEl = document.querySelector('#trigger')
var tab = bootstrap.Tab.getInstance(triggerEl) // Bootstrapタブ・インスタンスを返す

getOrCreateInstance v5.0.2追加

DOM要素に関連付けられたタブ・インスタンスを取得したり、初期化されていない場合に新しいインスタンスを作成したりできる静的メソッド。

JavaScriptコピーvar triggerEl = document.querySelector('#trigger')
var tab = bootstrap.Tab.getOrCreateInstance(triggerEl) // Bootstrapタブ・インスタンスを返す

イベント（Events）

新しいタブを表示すると、イベントは次の順序で発動：

1. hide.bs.tab（現在のアクティブなタブに）
2. show.bs.tab（次に表示されるタブに）
3. hidden.bs.tab（前のアクティブなタブでは hide.bs.tab イベントと同じもの）
4. shown.bs.tab（新しくアクティブ化されて表示されるタブでは show.bs.tab イベントと同じもの）

既にアクティブなタブがない場合、hide.bs.tab と hidden.bs.tab イベントは発動しない。

使用例 v5.0.2設定変更

JavaScriptvar tabElms = document.querySelectorAll('a[data-bs-toggle="list"]')
tabElms.forEach(function(tabElm) {
  tabElm.addEventListener('shown.bs.tab', function (event) {
    event.target // 新しくアクティブ化されたタブ
    event.relatedTarget // 前のアクティブなタブ
  })
}