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

プラグインは個別に (依存関係が必要なものもありますが)、または一度にすべて含めることができます。bootstrap.jsとbootstrap.min.jsの両方に、すべてのプラグインが 1 つのファイルに含まれています。

データ属性

すべての 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')。

競合なし

他の UI フレームワークで Bootstrap プラグインを使用する必要がある場合があります。このような状況では、名前空間の競合が発生することがあります。これが発生し.noConflictた場合は、値を元に戻したいプラグインを呼び出すことができます。

var bootstrapButton = $ . fn . ボタン。noConflict () // $.fn.button を以前に割り当てられた値に戻す 
$ . fn . bootstrapBtn = bootstrapButton             // $().bootstrapBtn にブートストラップ機能を与える

イベント

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 id = "myModal" class = "modal hide fade" 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" data-toggle = "dropdown" 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' ). ドロップダウン()

オプション

なし

メソッド

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

特定のナビゲーション バーまたはタブ ナビゲーションのメニューを切り替えるためのプログラム 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 を使用し、ローカル タイトル ストレージにデータ属性を使用します。

パフォーマンス上の理由から、ツールチップとポップオーバーのデータ API はオプトインされています。つまり、自分で初期化する必要があります。

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

四方

入力グループのツールチップ

Bootstrap 入力グループでツールチップとポップオーバーを使用する場合、container不要な副作用を避けるために (以下に記載されている) オプションを設定する必要があります。

使用法

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

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

オプション

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

マークアップ

<a href = "#" data-toggle = "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 btn-primary" data-toggle = "button" >シングル トグル</button>   

チェックボックス

data-toggle="buttons-checkbox"btn-group にチェックボックス スタイルの切り替えを追加します。

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

無線

data-toggle="buttons-radio"btn-group でのラジオ スタイルの切り替えを追加します。

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

使用法

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

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

マークアップ

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

オプション

なし

メソッド

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

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

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

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

Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute data-loading-text.

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

$().button('reset')

Resets button state - swaps text to original text.

$().button(string)

Resets button state - swaps text to any data defined text state.

<button type="button" class="btn" data-complete-text="finished!" >...</button>
<script>
  $('.btn').button('complete')
</script>

About

Get base styles and flexible support for collapsible components like accordions and navigation.

* Requires the Transitions plugin to be included.

Example accordion

Using the collapse plugin, we built a simple accordion style widget:

<div class="accordion" id="accordion2">
  <div class="accordion-group">
    <div class="accordion-heading">
      <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne">
        Collapsible Group Item #1
      </a>
    </div>
    <div id="collapseOne" class="accordion-body collapse in">
      <div class="accordion-inner">
        Anim pariatur cliche...
      </div>
    </div>
  </div>
  <div class="accordion-group">
    <div class="accordion-heading">
      <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo">
        Collapsible Group Item #2
      </a>
    </div>
    <div id="collapseTwo" class="accordion-body collapse">
      <div class="accordion-inner">
        Anim pariatur cliche...
      </div>
    </div>
  </div>
</div>
...

You can also use the plugin without the accordion markup. Make a button toggle the expanding and collapsing of another element.

<button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo">
  simple collapsible
</button>
 
<div id="demo" class="collapse in"> … </div>

Usage

Via data attributes

Just add data-toggle="collapse" and a data-target to element to automatically assign control of a collapsible element. The data-target attribute accepts a css selector to apply the collapse to. Be sure to add the class collapse to the collapsible element. If you'd like it to default open, add the additional class in.

To add accordion-like group management to a collapsible control, add the data attribute data-parent="#selector". Refer to the demo to see this in action.

Via JavaScript

Enable manually with:

$(".collapse").collapse()

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-parent="".

Methods

.collapse(options)

Activates your content as a collapsible element. Accepts an optional options object.

$('#myCollapsible').collapse({
  toggle: false
})

.collapse('toggle')

Toggles a collapsible element to shown or hidden.

.collapse('show')

Shows a collapsible element.

.collapse('hide')

Hides a collapsible element.

Events

Bootstrap's collapse class exposes a few events for hooking into collapse functionality.

$('#myCollapsible').on('hidden', function () {
  // do something…
})

Example carousel

The slideshow below shows a generic plugin and component for cycling through elements like a carousel.

First 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.

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="carousel slide">
  <ol class="carousel-indicators">
    <li data-target="#myCarousel" data-slide-to="0" class="active"></li>
    <li data-target="#myCarousel" data-slide-to="1"></li>
    <li data-target="#myCarousel" data-slide-to="2"></li>
  </ol>
  <!-- Carousel items -->
  <div class="carousel-inner">
    <div class="active item">…</div>
    <div class="item">…</div>
    <div class="item">…</div>
  </div>
  <!-- Carousel nav -->
  <a class="carousel-control left" href="#myCarousel" data-slide="prev">&lsaquo;</a>
  <a class="carousel-control right" href="#myCarousel" data-slide="next">&rsaquo;</a>
</div>

Usage

Via data attributes

Use data attributes to easily control the position of the carousel. data-slide accepts the keywords prev or next, which alters the slide position relative to it's current position. Alternatively, use data-slide-to to pass a raw slide index to the carousel data-slide-to="2", which jump's the slide position to a particular index beginning with 0.

Via JavaScript

Call carousel manually with:

$('.carousel').carousel()

Options

Options can be passed via data attributes or JavaScriptz. For data attributes, append the option name to data-, as in data-interval="".

Methods

.carousel(options)

Initializes the carousel with an optional options object and starts cycling through items.

$('.carousel').carousel({
  interval: 2000
})

.carousel('cycle')

Cycles through the carousel items from left to right.

.carousel('pause')

Stops the carousel from cycling through items.

.carousel(number)

Cycles the carousel to a particular frame (0 based, similar to an array).

.carousel('prev')

Cycles to the previous item.

.carousel('next')

Cycles to the next item.

Events

Bootstrap's carousel class exposes two events for hooking into carousel functionality.

Example

A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.

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

You'll want to set autocomplete="off" to prevent default browser menus from appearing over the Bootstrap typeahead dropdown.

Usage

Via data attributes

Add data attributes to register an element with typeahead functionality as shown in the example above.

Via JavaScript

Call the typeahead manually with:

$('.typeahead').typeahead()

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-source="".

Methods

.typeahead(options)

Initializes an input with a typeahead.

Example

The subnavigation on the left is a live demo of the affix plugin.

Usage

Via data attributes

To easily add affix behavior to any element, just add data-spy="affix" to the element you want to spy on. Then use offsets to define when to toggle the pinning of an element on and off.

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

Via JavaScript

Call the affix plugin via JavaScript:

$('#navbar').affix()

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset-top="200".