個別またはコンパイル済み

Bootstrap の最新バージョンをダウンロードした場合、bootstrap.jsとbootstrap.min.jsの両方に、このページにリストされているすべてのプラグインが含まれています。

データ属性

すべての Bootstrap プラグインは、JavaScript を 1 行も記述することなく、マークアップ API を介して純粋に使用できます。これは Bootstrap のファースト クラス API であり、プラグインを使用する際に最初に考慮する必要があります。

とはいえ、状況によっては、この機能をオフにすることが望ましい場合があります。したがって、`'data-api'` でネームスペース化された body のすべてのイベントのバインドを解除することにより、データ属性 API を無効にする機能も提供します。これは次のようになります。

$ ( 「本体」)。オフ( 「.data-api」)

または、特定のプラグインをターゲットにするには、次のように data-api 名前空間とともにプラグイン名を名前空間として含めるだけです。

$ ( 「本体」)。オフ( 「.alert.data-api」)

プログラム API

また、すべての Bootstrap プラグインを純粋に JavaScript API を介して使用できるべきだと考えています。すべてのパブリック API は単一の連鎖可能なメソッドであり、操作対象のコレクションを返します。

$ ( ".btn.danger" ). ボタン( 「トグル」)。addClass ( "脂肪" )

すべてのメソッドは、オプションのオプション オブジェクト、特定のメソッドを対象とする文字列、または何も受け入れない (デフォルトの動作でプラグインを開始する) 必要があります。

$ ( "#myModal" ). modal () // デフォルトで初期化                       
$ ( "#myModal" ). modal ({ keyboard : false }) // キーボードなしで初期化     
$ ( "#myModal" ). modal ( 'show' ) // すぐにショーを初期化して呼び出す                

各プラグインは、`Constructor` プロパティで生のコンストラクタも公開します: $.fn.popover.Constructor. 特定のプラグイン インスタンスを取得する場合は、要素から直接取得します: $('[rel=popover]').data('popover')。

イベント

Bootstrap は、ほとんどのプラグイン固有のアクションに対してカスタム イベントを提供します。一般に、これらは不定詞と過去分詞形で提供されます。不定詞 (例: show) はイベントの開始時にトリガーされ、過去分詞形 (例: shown) はアクションの完了時にトリガーされます。

すべての不定イベントは preventDefault 機能を提供します。これにより、アクションの実行を開始前に停止することができます。

$ ( '#myModal' ). on ( 'ショー' ,関数( e ) {   
    if (! data ) return e . preventDefault () // モーダルの表示を停止します   
}))

トランジションについて

シンプルなトランジション効果の場合は、bootstrap-transition.js を他の JS ファイルと一緒に 1 回インクルードします。コンパイル済み (または圧縮済み) の bootstrap.js を使用している場合は、これを含める必要はありません。既に存在します。

ユースケース

移行プラグインのいくつかの例:

• モーダルでのスライドまたはフェード
• タブのフェードアウト
• アラートのフェードアウト
• スライディング カルーセル ペイン

例

モーダルは合理化されていますが、必要最小限の機能とスマートなデフォルトを備えた柔軟なダイアログ プロンプトです。

静的な例

ヘッダー、本文、およびフッターの一連のアクションを含むレンダリングされたモーダル。

<divクラス= "モーダル非表示フェード" > 
  <divクラス= "モーダル ヘッダー" > 
    <button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × </ボタン>    
    <h3>モーダル ヘッダー</h3>
  </div>
  <div class = "modal-body" > 
    <p> 1 つの素晴らしいボディ… </p>
  </div>
  <div class = "modal-footer" > 
    <a href = "#" class = "btn" >閉じる</a>  
    <a href = "#" class = "btn btn-primary" >変更を保存</a>  
  </div>
</div>

ライブデモ

下のボタンをクリックして、JavaScript でモーダルを切り替えます。ページの上部から下にスライドしてフェードインします。

<-- モーダルをトリガーするボタン -->
<a href = "#myModal" role = "button" class = "btn" data-toggle = "modal" >デモ モーダルを起動</a>    
 
<-- モーダル -->
<div class = "modal" id = "myModal" tabindex = "-1" role = "dialog" aria- labelledby = "myModalLabel" aria-hidden = "true" >      
  <divクラス= "モーダル ヘッダー" > 
    <button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × </button>    
    <h3 id = "myModalLabel" >モーダル ヘッダー</h3> 
  </div>
  <div class = "modal-body" > 
    <p> 1 つの素晴らしいボディ… </p>
  </div>
  <div class = "modal-footer" > 
    <button class = "btn" data-dismiss = "modal" aria-hidden = "true" >閉じる</button>   
    <button class = "btn btn-primary" >変更を保存</button> 
  </div>
</div>

使用法

データ属性経由

JavaScript を書かずにモーダルを有効にします。特定のモーダルを切り替え対象にするために、 ordata-toggle="modal"とともに、ボタンなどのコントローラー要素に設定します。data-target="#foo"href="#foo"

<button type = "button" data-toggle = "modal" data-target = "#myModal" >モーダルを起動</button>   

JavaScript 経由

myModalJavaScript の 1 行でid を使用してモーダルを呼び出します。

$ ( '#myModal' ). モーダル(オプション)

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-backdrop=""。

<a data-toggle="modal" href="remote.html" data-target="#modal">click me</a>

メソッド

.modal(オプション)

コンテンツをモーダルとしてアクティブにします。オプションのオプションを受け入れますobject。

$ ( '#myModal' ). モーダル({
  キーボード: false 
}))

.modal('トグル')

モーダルを手動で切り替えます。

$ ( '#myModal' ). モーダル( 「トグル」)

.modal('表示')

モーダルを手動で開きます。

$ ( '#myModal' ). モーダル( 「表示」)

.modal('隠す')

モーダルを手動で非表示にします。

$ ( '#myModal' ). モーダル( 「非表示」)

イベント

Bootstrap のモーダル クラスは、モーダル機能にフックするためのいくつかのイベントを公開します。

$ ( '#myModal' ). on ( 'hidden' , function () {   
  //何かを…
}))

例

このシンプルなプラグインを使用して、ナビゲーション バー、タブ、ピルなど、ほぼすべてのものにドロップダウン メニューを追加します。

ナビゲーションバー内

タブ内

使用法

データ属性経由

data-toggle="dropdown"リンクまたはボタンに追加して、ドロップダウンを切り替えます。

<divクラス= "ドロップダウン" > 
  <a class = "dropdown-toggle" href = "#" >ドロップダウン トリガー</a>  
  <ul class = "dropdown -menu" role = "menu" aria- labelledby = "dLabel" >   
    ...
  </ul>
</div>

URL をそのまま維持するには、 のdata-target代わりに 属性を使用しますhref="#"。

<divクラス= "ドロップダウン" > 
  <a class = "dropdown-toggle" id = "dLabel" role = "button" data-toggle = "dropdown" data-target = "#" href = "/page.html" >      
    落ちる
    <b class = "キャレット" ></b> 
  </a>
  <ul class = "dropdown -menu" role = "menu" aria- labelledby = "dLabel" >   
    ...
  </ul>
</div>

JavaScript 経由

JavaScript を介してドロップダウンを呼び出します。

$ ( '.dropdown-toggle' ). ドロップダウン()

オプション

なし

メソッド

$().ドロップダウン()

特定のナビゲーション バーまたはタブ付きナビゲーションのメニューをアクティブ化するためのプログラム API。

ナビゲーションバーの例

ScrollSpy プラグインは、スクロール位置に基づいてナビゲーション ターゲットを自動的に更新するためのものです。ナビゲーションバーの下の領域をスクロールして、アクティブなクラスの変化を確認します。ドロップダウンのサブ項目も強調表示されます。

使用法

データ属性経由

scrollspy 動作をトップバー ナビゲーションに簡単に追加するdata-spy="scroll"には、スパイしたい要素 (通常は本文)data-target=".navbar"に追加し、使用するナビゲーションを選択します。コンポーネントで scrollspy を使用する必要があり.navます。

<body data-spy = "scroll" data-target = ".navbar" > ... </body>  

JavaScript 経由

JavaScript 経由で scrollspy を呼び出します。

$ ( '#navbar' ). スクロールスパイ()

メソッド

.scrollspy('リフレッシュ')

scrollspy を DOM からの要素の追加または削除と組み合わせて使用​​する場合、次のように refresh メソッドを呼び出す必要があります。

$ ( '[data-spy="scroll"]' ). それぞれ(関数() {  
  var $spy = $ ( this ). scrollspy ( 「リフレッシュ」)
});

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-offset=""。

イベント

タブの例

ドロップダウン メニューを介しても、ローカル コンテンツのペイン間を遷移するための迅速で動的なタブ機能を追加します。

使用法

JavaScript を介してタブ可能なタブを有効にします (各タブは個別に有効にする必要があります):

$ ( '#myTab a' ). クリック(関数( e ) {  
  e . preventDefault ();
  $ (これ)。タブ( 「表示」);
}))

いくつかの方法で個々のタブをアクティブ化できます。

$ ( '#myTab a[href="#profile"]' ). タブ( 「表示」); // 名前でタブを選択 
$ ( '#myTab a:first' ). タブ( 「表示」); // 最初のタブを選択 
$ ( '#myTab a:last' ). タブ( 「表示」); // 最後のタブを選択 
$ ( '#myTab li:eq(2) a' ). タブ( 「表示」); // 3 番目のタブ (0-indexed) を選択します 

マークアップ

data-toggle="tab"要素にまたはを指定するだけで、JavaScript を記述することなく、タブまたはピル ナビゲーションを有効にすることができますdata-toggle="pill"。navとnav-tabsクラスをタブに追加するとul、Bootstrap タブのスタイルが適用されます。

<ul class = "nav nav-tabs" > 
  <li><a href = "#home" data-toggle = "tab" >ホーム</a></li>  
  <li><a href = "#profile" data-toggle = "tab" >プロフィール</a></li>  
  <li><a href = "#messages" data-toggle = "tab" >メッセージ</a></li>  
  <li><a href = "#settings" data-toggle = "tab" >設定</a></li>  
</ul>

メソッド

$().tab

タブ要素とコンテンツ コンテナーをアクティブにします。タブには、DOM 内のコンテナ ノードを対象とするdata-targetまたはが必要です。href

<ul class = "nav nav-tabs" id = "myTab" >  
  <li class = "active" ><a href = "#home" >ホーム</a></li>  
  <li><a href = "#profile" >プロフィール</a></li> 
  <li><a href = "#messages" >メッセージ</a></li> 
  <li><a href = "#settings" >設定</a></li> 
</ul>
 
<div class = "tab-content" > 
  <divクラス= "タブ ペイン アクティブ" id = "ホーム" > ... </div>  
  <divクラス= "タブペイン" id = "プロファイル" > ... </div>  
  <divクラス= "タブペイン" id = "メッセージ" > ... </div>  
  <divクラス= "タブペイン" id = "設定" > ... </div>  
</div>
 
<スクリプト>
  $ (関数() {  
    $ ( '#myTab a:last' ). タブ( 「表示」);
  }))
</script>

イベント

$ ( 'a[data-toggle="タブ"]' ). on ( '示された' ,関数( e ) {   
  e . ターゲット// アクティブ化されたタブ
  e . relatedTarget // 前のタブ
}))

例

Jason Frame によって書かれた優れた jQuery.tipsy プラグインに触発されました。ツールチップは更新されたバージョンで、画像に依存せず、アニメーションに CSS3 を使用し、ローカル タイトル ストレージにデータ属性を使用します。

以下のリンクにカーソルを合わせると、ツールヒントが表示されます。

四方

使用法

JavaScript を介してツールチップをトリガーします。

$ ( '#例' ). ツールチップ(オプション)

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-animation=""。

マークアップ

パフォーマンス上の理由から、Tooltip および Popover データ API はオプトインされています。これらを使用する場合は、セレクター オプションを指定するだけです。

<a href = "#" rel = "tooltip" title = "最初のツールヒント" >カーソルを合わせる</a>   

メソッド

$().tooltip(オプション)

ツールヒント ハンドラーを要素コレクションにアタッチします。

.tooltip('表示')

要素のツールチップを表示します。

$ ( 「#要素」)。ツールチップ( 'show' )

.tooltip('非表示')

要素のツールチップを非表示にします。

$ ( 「#要素」)。ツールチップ( '隠す' )

.tooltip('トグル')

要素のツールチップを切り替えます。

$ ( 「#要素」)。ツールチップ( 'トグル' )

.tooltip('破壊')

要素のツールチップを非表示にして破棄します。

$ ( 「#要素」)。ツールチップ( 「破棄」)

例

二次情報を格納するために、iPad のようなコンテンツの小さなオーバーレイを任意の要素に追加します。ボタンにカーソルを合わせると、ポップオーバーがトリガーされます。ツールチップを含める必要があります。

静的ポップオーバー

上揃え、右揃え、下揃え、左揃えの 4 つのオプションを使用できます。

ポップオーバーとして表示されるマークアップは、JavaScript およびdata属性内のコンテンツから生成されません。

ライブデモ

使用法

JavaScript でポップオーバーを有効にします。

$ ( '#例' ). ポップオーバー(オプション)

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-animation=""。

マークアップ

パフォーマンス上の理由から、Tooltip および Popover データ API はオプトインされています。これらを使用する場合は、セレクター オプションを指定するだけです。

メソッド

$().popover(オプション)

要素コレクションのポップオーバーを初期化します。

.popover('表示')

要素のポップオーバーを表示します。

$ ( 「#要素」)。ポップオーバー( '表示' )

.popover('隠す')

要素のポップオーバーを非表示にします。

$ ( 「#要素」)。ポップオーバー( '隠す' )

.popover('トグル')

要素のポップオーバーを切り替えます。

$ ( 「#要素」)。ポップオーバー( 'トグル' )

.popover('破棄')

要素のポップオーバーを非表示にして破棄します。

$ ( 「#要素」)。ポップオーバー( 「破棄」)

アラートの例

このプラグインを使用して、すべてのアラート メッセージに却下機能を追加します。

使用法

JavaScript によるアラートの却下を有効にします。

$ ( ".alert" ). アラート()

マークアップ

閉じるボタンに追加data-dismiss="alert"するだけで、アラートを閉じる機能が自動的に提供されます。

<a class = "close" data-dismiss = "alert" href = "#" > × </a>   

メソッド

$().アラート()

すべてのアラートをクローズ機能でラップします。閉じたときにアラートがアニメーション化されるようにするには、アラートに.fadeand.inクラスが既に適用されていることを確認してください。

.alert('閉じる')

アラートを閉じます。

$ ( ".alert" ). アラート( 「閉じる」)

イベント

Bootstrap のアラート クラスは、アラート機能にフックするためのいくつかのイベントを公開します。

$ ( '#my-アラート' ). bind ( 'closed' , function () {   
  //何かを…
}))

使用例

ボタンをもっと活用しましょう。ボタンの状態を制御したり、ツールバーなどのその他のコンポーネント用にボタンのグループを作成したりします。

ステートフル

ボタンの読み込み状態を使用するには、data-loading-text="Loading..." を追加します。

<button type = "button" class = "btn btn-primary" data-loading-text = "Loading..." > Loading state </button>   

シングルトグル

data-toggle="button" を追加して、単一のボタンでトグルを有効にします。

<button type = "button" class = "btn" data-toggle = "button" >シングル トグル</button>   

チェックボックス

btn-group のチェックボックス スタイル トグル用に data-toggle="buttons-checkbox" を追加します。

<div class = "btn-group" data-toggle = "buttons-checkbox" >  
  <button type = "button" class = "btn" >左</button>  
  <button type = "button" class = "btn" > Middle </button>  
  <button type = "button" class = "btn" >右</button>  
</div>

無線

btn-group のラジオ スタイル トグル用に data-toggle="buttons-radio" を追加します。

<div class = "btn-group" data-toggle = "buttons-radio" >  
  <button type = "button" class = "btn" >左</button>  
  <button type = "button" class = "btn" > Middle </button>  
  <button type = "button" class = "btn" >右</button>  
</div>

使用法

JavaScript 経由でボタンを有効にします。

$ ( 「.nav-tabs」)。ボタン()

マークアップ

データ属性は、ボタン プラグインに不可欠です。さまざまなマークアップ タイプについては、以下のサンプル コードを確認してください。

オプション

なし

メソッド

$().button('トグル')

プッシュ状態を切り替えます。アクティブ化されたボタンの外観を与えます。

<button type = "button" class = "btn" data-toggle = "button" > … </button>    

$().button('読み込み中')

ボタンの状態を読み込み中に設定します - ボタンを無効にし、テキストを読み込み中のテキストに切り替えます。読み込み中のテキストは、ボタン要素で data 属性を使用して定義する必要がありますdata-loading-text。

<button type = "button" class = "btn" data-loading-text = "loading stuff..." > ... </button>    

$().button('リセット')

ボタンの状態をリセット - テキストを元のテキストに入れ替えます。

$().ボタン(文字列)

ボタンの状態をリセット - テキストを任意のデータ定義のテキスト状態にスワップします。

<button type = "button" class = "btn" data-complete-text = "finished!" > ... </button>    
<スクリプト>
  $ ( '.btn' )。ボタン( 「完了」)
</script>

約

アコーディオンやナビゲーションなどの折りたたみ可能なコンポーネントの基本スタイルと柔軟なサポートを取得します。

*トランジション プラグインが含まれている必要があります。

アコーディオンの例

collapse プラグインを使用して、シンプルなアコーディオン スタイルのウィジェットを作成しました。

<button type = "button" class = "btn btn-danger" data-toggle = "collapse" data-target = "#demo" >    
  シンプルな折りたたみ式
</ボタン>
 
<div id = "デモ"クラス= "折りたたむ" > … </div>  

使用法

データ属性経由

data-toggle="collapse"要素にとを追加するだけdata-targetで、折りたたみ可能な要素の制御を自動的に割り当てることができます。このdata-target属性は、折りたたみを適用する CSS セレクターを受け入れます。collapse折りたたみ可能な要素にクラスを必ず追加してください。デフォルトで開くようにしたい場合は、追加の class を追加しますin。

折りたたみ可能なコントロールにアコーディオンのようなグループ管理を追加するには、 data 属性を追加しますdata-parent="#selector"。実際の動作については、デモを参照してください。

JavaScript 経由

次を使用して手動で有効にします。

$ ( ".collapse" ). 折りたたむ()

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-parent=""。

メソッド

.collapse(オプション)

折りたたみ可能な要素としてコンテンツをアクティブにします。オプションのオプションを受け入れますobject。

$ ( '#myCollapsible' ). 崩壊（{
  トグル: false 
}))

.collapse('トグル')

折りたたみ可能な要素を表示または非表示に切り替えます。

.collapse('表示')

折りたたみ可能な要素を示します。

.collapse('隠す')

折りたたみ可能な要素を非表示にします。

イベント

Bootstrap の collapse クラスは、collapse 機能にフックするためのいくつかのイベントを公開します。

$ ( '#myCollapsible' ). on ( 'hidden' , function () {   
  //何かを…
}))

カルーセルの例

以下のスライドショーは、カルーセルのような要素を循環するための一般的なプラグインとコンポーネントを示しています。

最初のサムネイル ラベル

Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.

Second Thumbnail label

Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.

Third Thumbnail label

Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.

‹ ›

<div id = "myCarousel" class = "カルーセル スライド" >  
  <!-- カルーセル アイテム -->
  <div class = "carousel-inner" > 
    <divクラス= "アクティブなアイテム" > … </div> 
    <divクラス= "アイテム" > … </div> 
    <divクラス= "アイテム" > … </div> 
  </div>
  <!-- カルーセル ナビゲーション -->
  <a class = "carousel-control left" href = "#myCarousel" data-slide = "prev" > ‹ </a>   
  <a class = "carousel-control right" href = "#myCarousel" data-slide = "next" > › </a>   
</div>

使用法

データ属性経由

...

JavaScript 経由

次のように手動でカルーセルを呼び出します。

$ ( 「.carousel」)。カルーセル()

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-interval=""。

メソッド

.carousel(オプション)

オプションのオプションでカルーセルを初期化し、objectアイテムの循環を開始します。

$ ( 「.carousel」)。カルーセル({
  間隔: 2000 
}))

.carousel('サイクル')

カルーセル アイテムを左から右に循環します。

.carousel('一時停止')

カルーセルがアイテムを循環するのを止めます。

.carousel(数字)

カルーセルを特定のフレーム (0 ベース、配列と同様) に切り替えます。

.carousel('前の')

前のアイテムに循環します。

.carousel('次')

次のアイテムに循環します。

イベント

Bootstrap のカルーセル クラスは、カルーセル機能にフックするための 2 つのイベントを公開します。

例

任意のフォーム テキスト入力でエレガントな先行入力をすばやく作成するための基本的で簡単に拡張できるプラグイン。

<input type = "text" data-provide = "typeahead" >  

使用法

データ属性経由

上記の例に示すように、データ属性を追加して、先行入力機能を持つ要素を登録します。

JavaScript 経由

次を使用して手動で先行入力を呼び出します。

$ ( '.typeahead' ). 先行入力()

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-source=""。

メソッド

.typeahead(オプション)

先行入力で入力を初期化します。

例

左側のサブナビゲーションは接辞プラグインのライブ デモです。

使用法

データ属性経由

接辞動作を任意の要素に簡単に追加するdata-spy="affix"には、スパイしたい要素に追加するだけです。次に、オフセットを使用して、要素の固定のオンとオフをいつ切り替えるかを定義します。

<div data-spy = "affix" data-offset-top = "200" > ... </body>  

JavaScript 経由

JavaScript 経由で接辞プラグインを呼び出します。

$ ( '#navbar' ). 接辞()

メソッド

.affix('リフレッシュ')

DOM からの要素の追加または削除と組み合わせて affix を使用する場合は、refresh メソッドを呼び出す必要があります。

$ ( '[data-spy="affix"]' ). それぞれ(関数() {  
  $ (これ)。接辞( 「更新」)
});

オプション

オプションは、データ属性または JavaScript を介して渡すことができます。data-データ属性の場合、オプション名をのようにに追加しますdata-offset-top="200"。