Individuel ou compilé

Les plugins peuvent être inclus individuellement (bien que certains aient des dépendances requises), ou tous à la fois. bootstrap.js et bootstrap.min.js contiennent tous les plugins dans un seul fichier.

Attributs de données

Vous pouvez utiliser tous les plugins Bootstrap uniquement via l'API de balisage sans écrire une seule ligne de JavaScript. Il s'agit de l'API de première classe de Bootstrap et devrait être votre première considération lors de l'utilisation d'un plugin.

Cela dit, dans certaines situations, il peut être souhaitable de désactiver cette fonctionnalité. Par conséquent, nous offrons également la possibilité de désactiver l'API d'attribut de données en déliant tous les événements sur l'espace de noms du corps avec `'data-api'`. Cela ressemble à ceci :

$ ( 'corps' ). désactivé ( '.data-api' )

Alternativement, pour cibler un plugin spécifique, incluez simplement le nom du plugin en tant qu'espace de noms avec l'espace de noms data-api comme ceci :

$ ( 'corps' ). désactivé ( '.alert.data-api' )

API programmatique

Nous pensons également que vous devriez pouvoir utiliser tous les plugins Bootstrap uniquement via l'API JavaScript. Toutes les API publiques sont des méthodes uniques et chaînées et renvoient la collection sur laquelle elles ont agi.

$ ( ".btn.danger" ). bouton ( "basculer" ). addClass ( "gras" )

Toutes les méthodes doivent accepter un objet d'options optionnel, une chaîne qui cible une méthode particulière, ou rien (qui lance un plugin avec un comportement par défaut) :

$ ( "#monModal" ). modal () // initialisé avec les valeurs par défaut                       
$ ( "#monModal" ). modal ({ keyboard : false }) // initialisé sans clavier     
$ ( "#monModal" ). modal ( 'show' ) // initialise et invoque show immédiatement                

Chaque plugin expose également son constructeur brut sur une propriété `Constructor` : $.fn.popover.Constructor. Si vous souhaitez obtenir une instance de plugin particulière, récupérez-la directement à partir d'un élément : $('[rel=popover]').data('popover').

Pas de conflit

Parfois, il est nécessaire d'utiliser des plugins Bootstrap avec d'autres frameworks d'interface utilisateur. Dans ces circonstances, des collisions d'espaces de noms peuvent parfois se produire. Si cela se produit, vous pouvez appeler .noConflictle plugin dont vous souhaitez annuler la valeur.

var bootstrapButton = $ . fn . bouton . noConflict () // retourne $.fn.button à la valeur précédemment assignée 
$ . fn . bootstrapBtn = bootstrapButton             // donne à $().bootstrapBtn la fonctionnalité d'amorçage

Événements

Bootstrap fournit des événements personnalisés pour les actions uniques de la plupart des plugins. Généralement, ceux-ci se présentent sous une forme infinitive et participe passé - où l'infinitif (ex. show) est déclenché au début d'un événement, et sa forme de participe passé (ex. shown) est déclenchée à la fin d'une action.

Tous les événements infinitifs fournissent la fonctionnalité preventDefault. Cela permet d'arrêter l'exécution d'une action avant qu'elle ne démarre.

$ ( '#monModal' ). on ( 'montrer' , fonction ( e ) {   
    si (! données ) renvoie e . preventDefault () // empêche l'affichage du modal   
})

À propos des transitions

Pour des effets de transition simples, incluez bootstrap-transition.js une fois avec les autres fichiers JS. Si vous utilisez le fichier bootstrap.js compilé (ou minifié) , il n'est pas nécessaire de l'inclure, il est déjà là.

Cas d'utilisation

Quelques exemples du plugin de transition :

• Glissement ou fondu dans les modaux
• Disparition des onglets
• Disparition des alertes
• Vitres carrousel coulissantes

Exemples

Les modaux sont des invites de dialogue simplifiées, mais flexibles, avec les fonctionnalités minimales requises et des valeurs par défaut intelligentes.

Exemple statique

Un modal rendu avec un en-tête, un corps et un ensemble d'actions dans le pied de page.

<div class = "modal hide fade" > 
  <div class = "en-tête-modal" > 
    < type de bouton = "bouton" class = "fermer" data-dismiss = "modal" aria-hidden = "true" > × </bouton>    
    <h3> En-tête modal </h3>
  </div>
  <div class = "modal-body" > 
    <p> Un beau corps… </p>
  </div>
  <div class = "modal-footer" > 
    <a href = "#" class = "btn" > Fermer </a>  
    <a href = "#" class = "btn btn-primary" > Enregistrer les modifications </a>  
  </div>
</div>

Démo en direct

Basculez un modal via JavaScript en cliquant sur le bouton ci-dessous. Il glissera vers le bas et s'estompera à partir du haut de la page.

<!-- Bouton pour déclencher modal -->
<a href = "#myModal" role = "button" class = "btn" data-toggle = "modal" > Lancer la démo modale </a>    
 
<!--Modalité -->
<div id = "myModal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >      
  <div class = "en-tête-modal" > 
    <button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × </button>    
    <h3 id = "myModalLabel" > En -tête modal </h3> 
  </div>
  <div class = "modal-body" > 
    <p> Un beau corps… </p>
  </div>
  <div class = "modal-footer" > 
    <bouton class = "btn" data-dismiss = "modal" aria-hidden = "true" > Fermer </button>   
    <button class = "btn btn-primary" > Enregistrer les modifications </button> 
  </div>
</div>

Usage

Via les attributs de données

Activez un modal sans écrire de JavaScript. Définissez data-toggle="modal"un élément de contrôleur, comme un bouton, avec un data-target="#foo"ou href="#foo"pour cibler un modal spécifique à basculer.

<button type = "button" data-toggle = "modal" data-target = "#myModal" > Lancer modal </button>   

Via Javascript

Appelez un modal avec id myModalavec une seule ligne de JavaScript :

$ ( '#monModal' ). modale ( options )

Choix

Les options peuvent être transmises via des attributs de données ou JavaScript. Pour les attributs de données, ajoutez le nom de l'option à data-, comme dans data-backdrop="".

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

Méthodes

.modal(options)

Active votre contenu en tant que modal. Accepte une option facultative object.

$ ( '#monModal' ). modale ({
  clavier : faux 
})

.modal('basculer')

Bascule manuellement un modal.

$ ( '#monModal' ). modal ( 'basculer' )

.modal('montrer')

Ouvre manuellement un modal.

$ ( '#monModal' ). modal ( 'montrer' )

.modal('masquer')

Masque manuellement un modal.

$ ( '#monModal' ). modal ( 'cacher' )

Événements

La classe modale de Bootstrap expose quelques événements pour se connecter à la fonctionnalité modale.

$ ( '#monModal' ). on ( 'caché' , fonction () {   
  // faire quelque chose…
})

Exemples

Ajoutez des menus déroulants à presque tout avec ce plugin simple, y compris la barre de navigation, les onglets et les pilules.

Dans une barre de navigation

Dans les onglets

Usage

Via les attributs de données

Ajouter data-toggle="dropdown"à un lien ou à un bouton pour basculer vers une liste déroulante.

< classe div = "liste déroulante" > 
  <a class = "dropdown-toggle" data-toggle = "dropdown" href = "#" > Déclencheur déroulant </a>   
  <ul class = "dropdown-menu" role = "menu" aria-labelledby = "dLabel" >   
    ...
  </ul>
</div>

Pour conserver les URL intactes, utilisez l' data-targetattribut au lieu de href="#".

< classe div = "liste déroulante" > 
  <a class = "dropdown-toggle" id = "dLabel" role = "button" data-toggle = "dropdown" data-target = "#" href = "/page.html" >      
    Menu déroulant
    <b classe = "caret" ></b> 
  </a>
  <ul class = "dropdown-menu" role = "menu" aria-labelledby = "dLabel" >   
    ...
  </ul>
</div>

Via Javascript

Appelez les listes déroulantes via JavaScript :

$ ( '.dropdown-toggle' ). liste déroulante ()

Choix

Aucun

Méthodes

$().dropdown('basculer')

Une API programmatique pour basculer les menus pour une barre de navigation donnée ou une navigation par onglets.

Exemple dans la barre de navigation

Le plugin ScrollSpy permet de mettre à jour automatiquement les cibles de navigation en fonction de la position de défilement. Faites défiler la zone sous la barre de navigation et regardez la classe active changer. Les sous-éléments de la liste déroulante seront également mis en surbrillance.

Usage

Via les attributs de données

Pour ajouter facilement un comportement scrollspy à votre navigation dans la barre supérieure, ajoutez simplement data-spy="scroll"l'élément que vous souhaitez espionner (le plus souvent, il s'agit du corps) et data-target=".navbar"sélectionnez la navigation à utiliser. Vous voudrez utiliser scrollspy avec un .navcomposant.

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

Via Javascript

Appelez le scrollspy via JavaScript :

$ ( '#barre de navigation' ). parcheminespion ()

Méthodes

.scrollspy('actualiser')

Lorsque vous utilisez scrollspy en conjonction avec l'ajout ou la suppression d'éléments du DOM, vous devrez appeler la méthode refresh comme ceci :

$ ( '[data-spy="scroll"]' ). chaque ( fonction () {  
  var $espion = $ ( ceci ). scrollspy ( 'actualiser' )
});

Choix

Les options peuvent être transmises via des attributs de données ou JavaScript. Pour les attributs de données, ajoutez le nom de l'option à data-, comme dans data-offset="".

Événements

Exemples d'onglets

Ajoutez une fonctionnalité d'onglet rapide et dynamique pour passer d'un volet à l'autre du contenu local, même via des menus déroulants.

Usage

Activer les onglets tabulables via JavaScript (chaque onglet doit être activé individuellement) :

$ ( '#myTab a' ). cliquez sur ( fonction ( e ) {  
  e . preventDefault ();
  $ ( ceci ). onglet ( 'afficher' );
})

Vous pouvez activer des onglets individuels de plusieurs manières :

$ ( '#myTab a[href="#profile"]' ). onglet ( 'afficher' ); // Sélectionner l'onglet par nom 
$ ( '#myTab a:first' ). onglet ( 'afficher' ); // Sélectionner le premier onglet 
$ ( '#myTab a:last' ). onglet ( 'afficher' ); // Sélectionner le dernier onglet 
$ ( '#myTab li:eq(2) a' ). onglet ( 'afficher' ); // Sélectionne le troisième onglet (indexé à 0) 

Balisage

Vous pouvez activer une navigation par onglets ou pilules sans écrire de JavaScript en spécifiant simplement data-toggle="tab"ou data-toggle="pill"sur un élément. L'ajout des classes navet à l'onglet appliquera le style de l'onglet Bootstrap.nav-tabsul

<ul class = "nav nav-onglets" > 
  <li><a href = "#home" data-toggle = "tab" > Accueil </a></li>  
  <li><a href = "#profile" data-toggle = "tab" > Profil </a></li>  
  <li><a href = "#messages" data-toggle = "tab" > Messagerie </a></li>  
  <li><a href = "#settings" data-toggle = "tab" > Paramètres </a></li>  
</ul>

Méthodes

$().tab

Active un élément d'onglet et un conteneur de contenu. L'onglet doit avoir un data-targetou un hrefciblant un nœud de conteneur dans le DOM.

<ul class = "nav nav-tabs" id = "myTab" >  
  <li class = "active" ><a href = "#home" > Accueil </a></li>  
  <li><a href = "#profile" > Profil </a></li> 
  <li><a href = "#messages" > Messagerie </a></li> 
  <li><a href = "#settings" > Paramètres </a></li> 
</ul>
 
<div class = "tab-content" > 
  <div class = "tab-pane active" id = "home" > ... </div>  
  <div class = "tab-pane" id = "profil" > ... </div>  
  <div class = "tab-pane" id = "messages" > ... </div>  
  <div class = "tab-pane" id = "paramètres" > ... </div>  
</div>
 
<script>
  $ ( fonction () {  
    $ ( '#myTab a:last' ). onglet ( 'afficher' );
  })
</script>

Événements

$ ( 'a[data-toggle="tab"]' ). on ( 'montré' , fonction ( e ) {   
  e . cible // onglet activé
  e . relatedTarget // onglet précédent
})

Exemples

Inspiré de l'excellent plugin jQuery.tipsy écrit par Jason Frame ; Les info-bulles sont une version mise à jour, qui ne repose pas sur des images, utilise CSS3 pour les animations et les attributs de données pour le stockage local des titres.

Pour des raisons de performances, l'info-bulle et les API de données contextuelles sont opt-in, ce qui signifie que vous devez les initialiser vous -même .

Passez la souris sur les liens ci-dessous pour afficher les info-bulles :

Quatre directions

Info-bulles dans les groupes d'entrée

Lorsque vous utilisez des info-bulles et des popovers avec les groupes d'entrée Bootstrap, vous devrez définir l' containeroption (documentée ci-dessous) pour éviter les effets secondaires indésirables.

Usage

Déclenchez l'info-bulle via JavaScript :

$ ( '#exemple' ). info -bulle ( options )

Choix

Les options peuvent être transmises via des attributs de données ou JavaScript. Pour les attributs de données, ajoutez le nom de l'option à data-, comme dans data-animation="".

Balisage

<a href = "#" data-toggle = "tooltip" title = "first tooltip" > passez la souris sur moi </a>   

Méthodes

$().info-bulle(options)

Attache un gestionnaire d'info-bulles à une collection d'éléments.

.tooltip('montrer')

Révèle l'info-bulle d'un élément.

$ ( '#élément' ). info -bulle ( 'afficher' )

.tooltip('masquer')

Masque l'info-bulle d'un élément.

$ ( '#élément' ). info -bulle ( 'masquer' )

.tooltip('basculer')

Bascule l'info-bulle d'un élément.

$ ( '#élément' ). info -bulle ( 'basculer' )

.tooltip('détruire')

Masque et détruit l'info-bulle d'un élément.

$ ( '#élément' ). info -bulle ( 'détruire' )

Exemples

Ajoutez de petites superpositions de contenu, comme celles de l'iPad, à n'importe quel élément pour héberger des informations secondaires. Survolez le bouton pour déclencher le popover. L'info - bulle doit être incluse.

Popover statique

Quatre options sont disponibles : aligné en haut, à droite, en bas et à gauche.

Aucun balisage affiché car les popovers ne sont générés à partir de JavaScript et du contenu d'un dataattribut.

Démo en direct

Quatre directions

Usage

Activez les popovers via JavaScript :

$ ( '#exemple' ). popover ( options )

Choix

Les options peuvent être transmises via des attributs de données ou JavaScript. Pour les attributs de données, ajoutez le nom de l'option à data-, comme dans data-animation="".

Balisage

Pour des raisons de performances, les API de données Tooltip et Popover sont opt-in. Si vous souhaitez les utiliser, spécifiez simplement une option de sélection.

Méthodes

$().popover(options)

Initialise les popovers pour une collection d'éléments.

.popover('montrer')

Révèle un popover d'éléments.

$ ( '#élément' ). popover ( 'montrer' )

.popover('masquer')

Masque un popover d'éléments.

$ ( '#élément' ). popover ( 'cacher' )

.popover('basculer')

Bascule un popover d'éléments.

$ ( '#élément' ). popover ( 'basculer' )

.popover('détruire')

Masque et détruit le popover d'un élément.

$ ( '#élément' ). popover ( 'détruire' )

Exemples d'alertes

Ajoutez la fonctionnalité de rejet à tous les messages d'alerte avec ce plugin.

Usage

Activer le rejet d'une alerte via JavaScript :

$ ( ".alerte" ). alerte ()

Balisage

Ajoutez simplement data-dismiss="alert"à votre bouton de fermeture pour donner automatiquement une fonctionnalité de fermeture d'alerte.

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

Méthodes

$().alerte()

Enveloppe toutes les alertes avec une fonctionnalité proche. Pour que vos alertes s'animent lorsqu'elles sont fermées, assurez-vous que la .fadeet la .inclasse leur sont déjà appliquées.

.alerte('fermer')

Ferme une alerte.

$ ( ".alerte" ). alerte ( 'fermer' )

Événements

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

$('#my-alert').bind('closed', function () {
  // do something…
})

Example uses

Do more with buttons. Control button states or create groups of buttons for more components like toolbars.

Stateful

Add data-loading-text="Loading..." to use a loading state on a button.

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

Single toggle

Add data-toggle="button" to activate toggling on a single button.

<button type="button" class="btn btn-primary" data-toggle="button">Single Toggle</button>

Checkbox

Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group.

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

Radio

Add data-toggle="buttons-radio" for radio style toggling on btn-group.

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

Usage

Enable buttons via JavaScript:

$('.nav-tabs').button()

Markup

Data attributes are integral to the button plugin. Check out the example code below for the various markup types.

Options

None

Methods

$().button('toggle')

Toggles push state. Gives the button the appearance that it has been activated.

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

$().button('loading')

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