ドロップダウン
Bootstrapドロップダウンプラグインを使用して、リンクのリストなどを表示するためのコンテキストオーバーレイを切り替えます。
概要
ドロップダウンは、リンクのリストなどを表示するための、切り替え可能なコンテキストオーバーレイです。Bootstrapに含まれるドロップダウンJavaScriptプラグインでインタラクティブになります。ホバーではなくクリックで切り替えられます。これは意図的な設計上の決定です。
ドロップダウンは、動的な位置決めとビューポート検出を提供するサードパーティライブラリ、Popperを基に構築されています。BootstrapのJavaScriptの前にpopper.min.jsを含めるか、Popperを含むbootstrap.bundle.min.js
/ bootstrap.bundle.js
を使用してください。Popperはナビゲーションバーのドロップダウンの位置決めには使用されません。動的な位置決めは必要ないためです。
アクセシビリティ
WAI ARIA標準は、実際のrole="menu"
ウィジェットを定義していますが、これはアクションまたは機能をトリガーするアプリケーションのようなメニューに固有のものです。ARIAメニューには、メニュー項目、チェックボックスメニュー項目、ラジオボタンメニュー項目、ラジオボタングループ、およびサブメニューのみを含めることができます。
一方、Bootstrapのドロップダウンは、一般的なもので、さまざまな状況やマークアップ構造に適用できるように設計されています。たとえば、検索フィールドやログインフォームなど、追加の入力やフォームコントロールを含むドロップダウンを作成できます。このため、Bootstrapは、真のARIAメニューに必要なrole
属性やaria-
属性を期待(または自動的に追加)しません。作成者は、これらのより具体的な属性を自分で含める必要があります。
ただし、Bootstrapは、カーソルキーを使用して個々の.dropdown-item
要素を移動したり、Escキーでメニューを閉じたりするなど、ほとんどの標準的なキーボードメニュー操作の組み込みサポートを追加します。
例
ドロップダウンのトグル(ボタンまたはリンク)とドロップダウンメニューを.dropdown
内、またはposition: relative;
を宣言する別の要素内にラップします。理想的には、ドロップダウントリガーとして<button>
要素を使用する必要がありますが、プラグインは<a>
要素でも機能します。ここで示す例では、必要に応じてセマンティックな<ul>
要素を使用していますが、カスタムマークアップもサポートされています。
単一ボタン
単一の.btn
は、いくつかのマークアップを変更することで、ドロップダウントグルに変えることができます。<button>
要素でそれらを動作させる方法は次のとおりです。
<div class="dropdown">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown button
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
<button>
はドロップダウントグルに推奨されるコントロールですが、<a>
要素を使用する必要がある場合もあります。その場合は、スクリーンリーダーなどの支援技術にコントロールの目的を適切に伝えるために、role="button"
属性を追加することをお勧めします。
<div class="dropdown">
<a class="btn btn-secondary dropdown-toggle" href="#" role="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown link
</a>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
最も良い点は、任意のボタンのバリエーションでもこれを行うことができることです。
<!-- Example single danger button -->
<div class="btn-group">
<button type="button" class="btn btn-danger dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Action
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
分割ボタン
同様に、単一ボタンのドロップダウンとほぼ同じマークアップで分割ボタンのドロップダウンを作成できますが、ドロップダウンキャレットの周囲の適切な間隔のために.dropdown-toggle-split
が追加されています。
この追加のクラスを使用して、キャレットの両側の水平padding
を25%削減し、通常のボタンのドロップダウンに追加されるmargin-left
を削除します。これらの追加の変更により、キャレットが分割ボタンの中央に配置され、メインボタンの横に適切なサイズのヒット領域が提供されます。
<!-- Example split danger button -->
<div class="btn-group">
<button type="button" class="btn btn-danger">Action</button>
<button type="button" class="btn btn-danger dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
サイズ調整
ボタンのドロップダウンは、デフォルトや分割ドロップダウンボタンなど、すべてのサイズのボタンで機能します。
<!-- Large button groups (default and split) -->
<div class="btn-group">
<button class="btn btn-secondary btn-lg dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Large button
</button>
<ul class="dropdown-menu">
...
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary btn-lg" type="button">
Large split button
</button>
<button type="button" class="btn btn-lg btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
...
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary btn-sm dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Small button
</button>
<ul class="dropdown-menu">
...
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary btn-sm" type="button">
Small split button
</button>
<button type="button" class="btn btn-sm btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
...
</ul>
</div>
ダークドロップダウン
v5.3.0で非推奨既存の.dropdown-menu
に.dropdown-menu-dark
を追加して、ダークナビゲーションバーやカスタムスタイルに合わせて、より暗いドロップダウンを選択します。ドロップダウン項目に変更は必要ありません。
注意!コンポーネントのダークバリアントは、カラーモードの導入によりv5.3.0で非推奨になりました。.dropdown-menu-dark
を追加する代わりに、ルート要素、親ラッパー、またはコンポーネント自体にdata-bs-theme="dark"
を設定します。
<div class="dropdown">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown button
</button>
<ul class="dropdown-menu dropdown-menu-dark">
<li><a class="dropdown-item active" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
ナビゲーションバーでの使用例
<nav class="navbar navbar-expand-lg navbar-dark bg-dark">
<div class="container-fluid">
<a class="navbar-brand" href="#">Navbar</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarNavDarkDropdown" aria-controls="navbarNavDarkDropdown" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarNavDarkDropdown">
<ul class="navbar-nav">
<li class="nav-item dropdown">
<button class="btn btn-dark dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown
</button>
<ul class="dropdown-menu dropdown-menu-dark">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
方向
.dropstart
は右側に表示されます。中央揃え
親要素に.dropdown-center
を指定して、ドロップダウンメニューをトグルの下に中央揃えにします。
<div class="dropdown-center">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Centered dropdown
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Action two</a></li>
<li><a class="dropdown-item" href="#">Action three</a></li>
</ul>
</div>
ドロップアップ
親要素に.dropup
を追加して、要素の上にドロップダウンメニューをトリガーします。
<!-- Default dropup button -->
<div class="btn-group dropup">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropup
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
</div>
<!-- Split dropup button -->
<div class="btn-group dropup">
<button type="button" class="btn btn-secondary">
Split dropup
</button>
<button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
</div>
ドロップアップ中央揃え
親要素に.dropup-center
を指定して、ドロップアップメニューをトグルの上に中央揃えにします。
<div class="dropup-center dropup">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Centered dropup
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Action two</a></li>
<li><a class="dropdown-item" href="#">Action three</a></li>
</ul>
</div>
ドロップエンド
親要素に.dropend
を追加して、要素の右側にドロップダウンメニューをトリガーします。
<!-- Default dropend button -->
<div class="btn-group dropend">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropend
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
</div>
<!-- Split dropend button -->
<div class="btn-group dropend">
<button type="button" class="btn btn-secondary">
Split dropend
</button>
<button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropend</span>
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
</div>
ドロップスタート
親要素に.dropstart
を追加して、要素の左側にドロップダウンメニューをトリガーします。
<!-- Default dropstart button -->
<div class="btn-group dropstart">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropstart
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
</div>
<!-- Split dropstart button -->
<div class="btn-group dropstart">
<button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false">
<span class="visually-hidden">Toggle Dropstart</span>
</button>
<ul class="dropdown-menu">
<!-- Dropdown menu links -->
</ul>
<button type="button" class="btn btn-secondary">
Split dropstart
</button>
</div>
メニュー項目
<a>
要素または<button>
要素をドロップダウン項目として使用できます。
<div class="dropdown">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown
</button>
<ul class="dropdown-menu">
<li><button class="dropdown-item" type="button">Action</button></li>
<li><button class="dropdown-item" type="button">Another action</button></li>
<li><button class="dropdown-item" type="button">Something else here</button></li>
</ul>
</div>
.dropdown-item-text
を使用して、インタラクティブではないドロップダウン項目を作成することもできます。カスタムCSSまたはテキストユーティリティでさらに自由にスタイルを設定できます。
<ul class="dropdown-menu">
<li><span class="dropdown-item-text">Dropdown item text</span></li>
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
アクティブ
ドロップダウンの項目に.active
を追加して、アクティブとしてスタイルを設定します。支援技術にアクティブ状態を伝えるには、aria-current
属性を使用します。現在のページにはpage
値を、セット内の現在の項目にはtrue
値を使用します。
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Regular link</a></li>
<li><a class="dropdown-item active" href="#" aria-current="true">Active link</a></li>
<li><a class="dropdown-item" href="#">Another link</a></li>
</ul>
無効
ドロップダウンの項目に.disabled
を追加して、無効としてスタイルを設定します。
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Regular link</a></li>
<li><a class="dropdown-item disabled" aria-disabled="true">Disabled link</a></li>
<li><a class="dropdown-item" href="#">Another link</a></li>
</ul>
メニューの配置
デフォルトでは、ドロップダウンメニューは親の左側に沿って上部から100%自動的に配置されます。方向性のある.drop*
クラスでこれを変更できますが、追加の修飾子クラスで制御することもできます。
ドロップダウンメニューを右揃えにするには、.dropdown-menu
に.dropdown-menu-end
を追加します。BootstrapをRTLで使用する場合、方向はミラーリングされます。つまり、.dropdown-menu-end
は左側に表示されます。
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Right-aligned menu example
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><button class="dropdown-item" type="button">Action</button></li>
<li><button class="dropdown-item" type="button">Another action</button></li>
<li><button class="dropdown-item" type="button">Something else here</button></li>
</ul>
</div>
レスポンシブ配置
レスポンシブ配置を使用する場合は、data-bs-display="static"
属性を追加して動的な位置決めを無効にし、レスポンシブバリエーションクラスを使用します。
指定されたブレークポイント以上でドロップダウンメニューを右に配置するには、.dropdown-menu{-sm|-md|-lg|-xl|-xxl}-end
を追加します。
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" data-bs-display="static" aria-expanded="false">
Left-aligned but right aligned when large screen
</button>
<ul class="dropdown-menu dropdown-menu-lg-end">
<li><button class="dropdown-item" type="button">Action</button></li>
<li><button class="dropdown-item" type="button">Another action</button></li>
<li><button class="dropdown-item" type="button">Something else here</button></li>
</ul>
</div>
ドロップダウンメニューを、指定されたブレークポイント以上で左揃えにするには、.dropdown-menu-end
と .dropdown-menu{-sm|-md|-lg|-xl|-xxl}-start
を追加します。
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" data-bs-display="static" aria-expanded="false">
Right-aligned but left aligned when large screen
</button>
<ul class="dropdown-menu dropdown-menu-end dropdown-menu-lg-start">
<li><button class="dropdown-item" type="button">Action</button></li>
<li><button class="dropdown-item" type="button">Another action</button></li>
<li><button class="dropdown-item" type="button">Something else here</button></li>
</ul>
</div>
ナビゲーションバーでは Popper が使用されないため、ドロップダウンボタンに data-bs-display="static"
属性を追加する必要はありません。
配置オプション
上記のオプションのほとんどを使用し、さまざまなドロップダウン配置オプションを 1 か所にまとめた、小さなキッチンのシンクのデモを次に示します。
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Right-aligned menu
</button>
<ul class="dropdown-menu dropdown-menu-end">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" data-bs-display="static" aria-expanded="false">
Left-aligned, right-aligned lg
</button>
<ul class="dropdown-menu dropdown-menu-lg-end">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" data-bs-display="static" aria-expanded="false">
Right-aligned, left-aligned lg
</button>
<ul class="dropdown-menu dropdown-menu-end dropdown-menu-lg-start">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group dropstart">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropstart
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group dropend">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropend
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group dropup">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
Dropup
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
メニューコンテンツ
ヘッダー
任意のドロップダウンメニューで、アクションのセクションをラベル付けするためにヘッダーを追加します。
<ul class="dropdown-menu">
<li><h6 class="dropdown-header">Dropdown header</h6></li>
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
</ul>
区切り線
関連するメニュー項目のグループを区切り線で区切ります。
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
テキスト
テキストを含むドロップダウンメニュー内に任意のフリーフォームテキストを配置し、スペーシングユーティリティを使用します。メニューの幅を制限するために、追加のサイズ調整スタイルが必要になる場合があることに注意してください。
<div class="dropdown-menu p-4 text-body-secondary" style="max-width: 200px;">
<p>
Some example text that's free-flowing within the dropdown menu.
</p>
<p class="mb-0">
And this is more example text.
</p>
</div>
フォーム
フォームをドロップダウンメニュー内に入れるか、ドロップダウンメニューにして、マージンまたはパディングユーティリティを使用して必要なネガティブスペースを与えます。
<div class="dropdown-menu">
<form class="px-4 py-3">
<div class="mb-3">
<label for="exampleDropdownFormEmail1" class="form-label">Email address</label>
<input type="email" class="form-control" id="exampleDropdownFormEmail1" placeholder="email@example.com">
</div>
<div class="mb-3">
<label for="exampleDropdownFormPassword1" class="form-label">Password</label>
<input type="password" class="form-control" id="exampleDropdownFormPassword1" placeholder="Password">
</div>
<div class="mb-3">
<div class="form-check">
<input type="checkbox" class="form-check-input" id="dropdownCheck">
<label class="form-check-label" for="dropdownCheck">
Remember me
</label>
</div>
</div>
<button type="submit" class="btn btn-primary">Sign in</button>
</form>
<div class="dropdown-divider"></div>
<a class="dropdown-item" href="#">New around here? Sign up</a>
<a class="dropdown-item" href="#">Forgot password?</a>
</div>
<div class="dropdown">
<button type="button" class="btn btn-primary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false" data-bs-auto-close="outside">
Dropdown form
</button>
<form class="dropdown-menu p-4">
<div class="mb-3">
<label for="exampleDropdownFormEmail2" class="form-label">Email address</label>
<input type="email" class="form-control" id="exampleDropdownFormEmail2" placeholder="email@example.com">
</div>
<div class="mb-3">
<label for="exampleDropdownFormPassword2" class="form-label">Password</label>
<input type="password" class="form-control" id="exampleDropdownFormPassword2" placeholder="Password">
</div>
<div class="mb-3">
<div class="form-check">
<input type="checkbox" class="form-check-input" id="dropdownCheck2">
<label class="form-check-label" for="dropdownCheck2">
Remember me
</label>
</div>
</div>
<button type="submit" class="btn btn-primary">Sign in</button>
</form>
</div>
ドロップダウンオプション
ドロップダウンの位置を変更するには、data-bs-offset
または data-bs-reference
を使用します。
<div class="d-flex">
<div class="dropdown me-1">
<button type="button" class="btn btn-secondary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false" data-bs-offset="10,20">
Offset
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
</ul>
</div>
<div class="btn-group">
<button type="button" class="btn btn-secondary">Reference</button>
<button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-bs-toggle="dropdown" aria-expanded="false" data-bs-reference="parent">
<span class="visually-hidden">Toggle Dropdown</span>
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Action</a></li>
<li><a class="dropdown-item" href="#">Another action</a></li>
<li><a class="dropdown-item" href="#">Something else here</a></li>
<li><hr class="dropdown-divider"></li>
<li><a class="dropdown-item" href="#">Separated link</a></li>
</ul>
</div>
</div>
自動クローズの動作
デフォルトでは、ドロップダウンメニューの内側または外側をクリックすると、ドロップダウンメニューが閉じます。autoClose
オプションを使用して、ドロップダウンのこの動作を変更できます。
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
Default dropdown
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" data-bs-auto-close="inside" aria-expanded="false">
Clickable inside
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" data-bs-auto-close="outside" aria-expanded="false">
Clickable outside
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
<div class="btn-group">
<button class="btn btn-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">
Manual close
</button>
<ul class="dropdown-menu">
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
<li><a class="dropdown-item" href="#">Menu item</a></li>
</ul>
</div>
CSS
変数
v5.2.0 で追加Bootstrap の進化する CSS 変数のアプローチの一環として、ドロップダウンでは、リアルタイムでのカスタマイズを強化するために、.dropdown-menu
でローカル CSS 変数を使用するようになりました。CSS 変数の値は Sass を介して設定されるため、Sass のカスタマイズも引き続きサポートされます。
--#{$prefix}dropdown-zindex: #{$zindex-dropdown};
--#{$prefix}dropdown-min-width: #{$dropdown-min-width};
--#{$prefix}dropdown-padding-x: #{$dropdown-padding-x};
--#{$prefix}dropdown-padding-y: #{$dropdown-padding-y};
--#{$prefix}dropdown-spacer: #{$dropdown-spacer};
@include rfs($dropdown-font-size, --#{$prefix}dropdown-font-size);
--#{$prefix}dropdown-color: #{$dropdown-color};
--#{$prefix}dropdown-bg: #{$dropdown-bg};
--#{$prefix}dropdown-border-color: #{$dropdown-border-color};
--#{$prefix}dropdown-border-radius: #{$dropdown-border-radius};
--#{$prefix}dropdown-border-width: #{$dropdown-border-width};
--#{$prefix}dropdown-inner-border-radius: #{$dropdown-inner-border-radius};
--#{$prefix}dropdown-divider-bg: #{$dropdown-divider-bg};
--#{$prefix}dropdown-divider-margin-y: #{$dropdown-divider-margin-y};
--#{$prefix}dropdown-box-shadow: #{$dropdown-box-shadow};
--#{$prefix}dropdown-link-color: #{$dropdown-link-color};
--#{$prefix}dropdown-link-hover-color: #{$dropdown-link-hover-color};
--#{$prefix}dropdown-link-hover-bg: #{$dropdown-link-hover-bg};
--#{$prefix}dropdown-link-active-color: #{$dropdown-link-active-color};
--#{$prefix}dropdown-link-active-bg: #{$dropdown-link-active-bg};
--#{$prefix}dropdown-link-disabled-color: #{$dropdown-link-disabled-color};
--#{$prefix}dropdown-item-padding-x: #{$dropdown-item-padding-x};
--#{$prefix}dropdown-item-padding-y: #{$dropdown-item-padding-y};
--#{$prefix}dropdown-header-color: #{$dropdown-header-color};
--#{$prefix}dropdown-header-padding-x: #{$dropdown-header-padding-x};
--#{$prefix}dropdown-header-padding-y: #{$dropdown-header-padding-y};
ドロップダウン項目には、.dropdown
に設定されていない少なくとも 1 つの変数が含まれています。これにより、Bootstrap がフォールバック値をデフォルトで使用している間に、新しい値を提供できます。
--bs-dropdown-item-border-radius
CSS 変数によるカスタマイズは、.dropdown-menu-dark
クラスで確認できます。ここでは、重複した CSS セレクターを追加せずに、特定の値を上書きします。
--#{$prefix}dropdown-color: #{$dropdown-dark-color};
--#{$prefix}dropdown-bg: #{$dropdown-dark-bg};
--#{$prefix}dropdown-border-color: #{$dropdown-dark-border-color};
--#{$prefix}dropdown-box-shadow: #{$dropdown-dark-box-shadow};
--#{$prefix}dropdown-link-color: #{$dropdown-dark-link-color};
--#{$prefix}dropdown-link-hover-color: #{$dropdown-dark-link-hover-color};
--#{$prefix}dropdown-divider-bg: #{$dropdown-dark-divider-bg};
--#{$prefix}dropdown-link-hover-bg: #{$dropdown-dark-link-hover-bg};
--#{$prefix}dropdown-link-active-color: #{$dropdown-dark-link-active-color};
--#{$prefix}dropdown-link-active-bg: #{$dropdown-dark-link-active-bg};
--#{$prefix}dropdown-link-disabled-color: #{$dropdown-dark-link-disabled-color};
--#{$prefix}dropdown-header-color: #{$dropdown-dark-header-color};
Sass 変数
すべてのドロップダウンの変数
$dropdown-min-width: 10rem;
$dropdown-padding-x: 0;
$dropdown-padding-y: .5rem;
$dropdown-spacer: .125rem;
$dropdown-font-size: $font-size-base;
$dropdown-color: var(--#{$prefix}body-color);
$dropdown-bg: var(--#{$prefix}body-bg);
$dropdown-border-color: var(--#{$prefix}border-color-translucent);
$dropdown-border-radius: var(--#{$prefix}border-radius);
$dropdown-border-width: var(--#{$prefix}border-width);
$dropdown-inner-border-radius: calc(#{$dropdown-border-radius} - #{$dropdown-border-width}); // stylelint-disable-line function-disallowed-list
$dropdown-divider-bg: $dropdown-border-color;
$dropdown-divider-margin-y: $spacer * .5;
$dropdown-box-shadow: var(--#{$prefix}box-shadow);
$dropdown-link-color: var(--#{$prefix}body-color);
$dropdown-link-hover-color: $dropdown-link-color;
$dropdown-link-hover-bg: var(--#{$prefix}tertiary-bg);
$dropdown-link-active-color: $component-active-color;
$dropdown-link-active-bg: $component-active-bg;
$dropdown-link-disabled-color: var(--#{$prefix}tertiary-color);
$dropdown-item-padding-y: $spacer * .25;
$dropdown-item-padding-x: $spacer;
$dropdown-header-color: $gray-600;
$dropdown-header-padding-x: $dropdown-item-padding-x;
$dropdown-header-padding-y: $dropdown-padding-y;
// fusv-disable
$dropdown-header-padding: $dropdown-header-padding-y $dropdown-header-padding-x; // Deprecated in v5.2.0
// fusv-enable
ダークドロップダウンの変数
$dropdown-dark-color: $gray-300;
$dropdown-dark-bg: $gray-800;
$dropdown-dark-border-color: $dropdown-border-color;
$dropdown-dark-divider-bg: $dropdown-divider-bg;
$dropdown-dark-box-shadow: null;
$dropdown-dark-link-color: $dropdown-dark-color;
$dropdown-dark-link-hover-color: $white;
$dropdown-dark-link-hover-bg: rgba($white, .15);
$dropdown-dark-link-active-color: $dropdown-link-active-color;
$dropdown-dark-link-active-bg: $dropdown-link-active-bg;
$dropdown-dark-link-disabled-color: $gray-500;
$dropdown-dark-header-color: $gray-500;
ドロップダウンのインタラクティビティを示す CSS ベースのカレットの変数
$caret-width: .3em;
$caret-vertical-align: $caret-width * .85;
$caret-spacing: $caret-width * .85;
Sass ミックスイン
ミックスインは CSS ベースのカレットを生成するために使用され、scss/mixins/_caret.scss
にあります。
@mixin caret-down($width: $caret-width) {
border-top: $width solid;
border-right: $width solid transparent;
border-bottom: 0;
border-left: $width solid transparent;
}
@mixin caret-up($width: $caret-width) {
border-top: 0;
border-right: $width solid transparent;
border-bottom: $width solid;
border-left: $width solid transparent;
}
@mixin caret-end($width: $caret-width) {
border-top: $width solid transparent;
border-right: 0;
border-bottom: $width solid transparent;
border-left: $width solid;
}
@mixin caret-start($width: $caret-width) {
border-top: $width solid transparent;
border-right: $width solid;
border-bottom: $width solid transparent;
}
@mixin caret(
$direction: down,
$width: $caret-width,
$spacing: $caret-spacing,
$vertical-align: $caret-vertical-align
) {
@if $enable-caret {
&::after {
display: inline-block;
margin-left: $spacing;
vertical-align: $vertical-align;
content: "";
@if $direction == down {
@include caret-down($width);
} @else if $direction == up {
@include caret-up($width);
} @else if $direction == end {
@include caret-end($width);
}
}
@if $direction == start {
&::after {
display: none;
}
&::before {
display: inline-block;
margin-right: $spacing;
vertical-align: $vertical-align;
content: "";
@include caret-start($width);
}
}
&:empty::after {
margin-left: 0;
}
}
}
使い方
データ属性または JavaScript を介して、ドロップダウンプラグインは、親 .dropdown-menu
で .show
クラスを切り替えることによって、非表示のコンテンツ(ドロップダウンメニュー)を切り替えます。data-bs-toggle="dropdown"
属性は、アプリケーションレベルでドロップダウンメニューを閉じるために使用されるため、常に使用することをお勧めします。
<body>
要素の直下の子に空の mouseover
ハンドラーが追加されます。このかなり醜いハックは、iOS のイベント委任の癖を回避するために必要であり、そうしないと、ドロップダウンの外側の任意の場所をタップすると、ドロップダウンを閉じるコードがトリガーされるのを防ぎます。ドロップダウンが閉じられると、これらの追加の空の mouseover
ハンドラーは削除されます。データ属性経由
ドロップダウンを切り替えるには、リンクまたはボタンに data-bs-toggle="dropdown"
を追加します。
<div class="dropdown">
<button type="button" data-bs-toggle="dropdown" aria-expanded="false">
Dropdown trigger
</button>
<ul class="dropdown-menu">
...
</ul>
</div>
JavaScript経由
data-bs-toggle="dropdown"
が必要です。JavaScript を介してドロップダウンを呼び出す
const dropdownElementList = document.querySelectorAll('.dropdown-toggle')
const dropdownList = [...dropdownElementList].map(dropdownToggleEl => new bootstrap.Dropdown(dropdownToggleEl))
オプション
オプションはデータ属性または JavaScript を介して渡すことができるため、data-bs-animation="{value}"
のように、オプション名を data-bs-
に追加できます。オプション名をデータ属性を介して渡す場合は、オプション名のケースタイプを "camelCase" から "kebab-case" に変更してください。たとえば、data-bs-customClass="beautifier"
ではなく data-bs-custom-class="beautifier"
を使用します。
Bootstrap 5.2.0 以降、すべてのコンポーネントは、JSON 文字列として単純なコンポーネント構成を格納できる実験的な予約済みデータ属性 data-bs-config
をサポートしています。要素に 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 オブジェクト
のマージされた結果であり、最新に指定されたキーと値がその他を上書きします。
名前 | 型 | デフォルト | 説明 |
---|---|---|---|
autoClose |
boolean, string | true |
ドロップダウンの自動クローズ動作を構成します
|
boundary |
string, element | 'clippingParents' |
ドロップダウンメニューのオーバーフロー制約境界(Popper の preventOverflow モディファイアーにのみ適用されます)。デフォルトでは clippingParents であり、HTMLElement リファレンスを受け入れることができます(JavaScript 経由のみ)。詳細については、Popper の detectOverflow ドキュメントを参照してください。 |
display |
string | 'dynamic' |
デフォルトでは、動的な配置には Popper を使用します。static を使用してこれを無効にします。 |
offset |
array, string, function | [0, 2] |
ターゲットに対するドロップダウンのオフセット。data-bs-offset="10,20" のように、カンマ区切りの値を持つデータ属性で文字列を渡すことができます。オフセットを決定するために関数が使用される場合、最初の引数として、popper の配置、リファレンス、および popper rect を含むオブジェクトが渡されます。トリガー要素 DOM ノードは 2 番目の引数として渡されます。関数は 2 つの数値の配列を返す必要があります:スキッド、距離。詳細については、Popper の オフセットドキュメントを参照してください。 |
popperConfig |
null, object, function | null |
Bootstrap のデフォルトの Popper 構成を変更するには、Popper の構成を参照してください。関数が Popper 構成を作成するために使用される場合、Bootstrap のデフォルトの Popper 構成を含むオブジェクトが渡されます。これにより、デフォルトと独自の構成を使用してマージできます。関数は Popper の構成オブジェクトを返す必要があります。 |
reference |
string, element, object | 'toggle' |
ドロップダウンメニューの参照要素。'toggle' 、'parent' 、HTMLElement 参照、または getBoundingClientRect を提供するオブジェクトの値を受け入れます。詳細については、Popper の コンストラクタードキュメントと 仮想要素ドキュメントを参照してください。 |
popperConfig
で関数を使用する
const dropdown = new bootstrap.Dropdown(element, {
popperConfig(defaultBsPopperConfig) {
// const newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
メソッド
メソッド | 説明 |
---|---|
dispose |
要素のドロップダウンを破棄します。(DOM 要素に格納されたデータを削除します) |
getInstance |
DOM 要素に関連付けられているドロップダウンインスタンスを取得できる静的メソッド。次のように使用できます: bootstrap.Dropdown.getInstance(element) 。 |
getOrCreateInstance |
DOM 要素に関連付けられたドロップダウンインスタンスを返すか、初期化されていない場合は新しいインスタンスを作成する静的メソッド。次のように使用できます: bootstrap.Dropdown.getOrCreateInstance(element) 。 |
hide |
指定されたナビゲーションバーまたはタブ付きナビゲーションのドロップダウンメニューを非表示にします。 |
show |
指定されたナビゲーションバーまたはタブ付きナビゲーションのドロップダウンメニューを表示します。 |
toggle |
指定されたナビゲーションバーまたはタブ付きナビゲーションのドロップダウンメニューを切り替えます。 |
update |
要素のドロップダウンの位置を更新します。 |
イベント
すべてのドロップダウンイベントは、切り替え要素で発生し、その後バブルアップします。そのため、.dropdown-menu
の親要素にイベントリスナーを追加することもできます。hide.bs.dropdown
および hidden.bs.dropdown
イベントには、クリックイベントのイベントオブジェクトを含む clickEvent
プロパティがあります(元のイベントタイプが click
の場合のみ)。
イベントタイプ | 説明 |
---|---|
hide.bs.dropdown |
hide インスタンスメソッドが呼び出されるとすぐに発生します。 |
hidden.bs.dropdown |
ドロップダウンがユーザーに非表示にされ、CSS トランジションが完了したときに発生します。 |
show.bs.dropdown |
show インスタンスメソッドが呼び出された直後に発生します。 |
shown.bs.dropdown |
ドロップダウンがユーザーに表示され、CSSトランジションが完了したときに発生します。 |
const myDropdown = document.getElementById('myDropdown')
myDropdown.addEventListener('show.bs.dropdown', event => {
// do something...
})