Bootstrap Plugin Scrollspy

Le plugin Scrollspy, c'est-à-dire le plugin de navigation à mise à jour automatique, met automatiquement à jour la cible de navigation correspondante en fonction de la position de la barre de défilement. Son implémentation de base consiste à ajouter à la barre de navigation en fonction de la position de la barre de défilement lors du défilement..active classe.

Si vous souhaitez référencer les fonctionnalités de ce plugin séparément, vous devez alors référencerscrollspy.js. Ou, commeAperçu des plugins Bootstrapmentionné dans le chapitre, vous pouvez référencerbootstrap.jsou la version compressée debootstrap.min.js。

Utilisation

Vous pouvez ajouter le comportement Scrollspy à la navigation supérieure :

  • Via les attributs de données: Ajoutez à l'élément que vous souhaitez surveiller (généralement le body)data-spy="scroll". Ajoutez ensuite avec Bootstrap.navl'attribut ID ou class de l'élément parent du composantdata-target. Pour que cela fonctionne correctement, vous devez vous assurer qu'un élément correspondant à l'ID du lien que vous souhaitez espionner existe dans le body de la page.
    <body data-spy="scroll" data-target=".navbar-example">
    ...
    <div class="navbar-example">
        <ul class="nav nav-tabs">
            ...
        </ul>
    </div>
    ...
    </body>
    
  • Via JavaScript: Vous pouvez appeler le Scrollspy via JavaScript, sélectionner l'élément à surveiller, puis appeler la fonction.scrollspy():
    $('body').scrollspy({ target: '.navbar-example' })
    

Exemple

L'exemple suivant montre l'utilisation du plugin Scrollspy via les attributs de données :

Exemple

<nav id="navbar-example" class="navbar navbar-default navbar-static" role="navigation"> <div class="container-fluid"> <div class="navbar-header"> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-scrollspy"> <span class="sr-only">Basculer la navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="#">Nom du tutoriel</a> </div> <div class="collapse navbar-collapse bs-js-navbar-scrollspy"> <ul class="nav navbar-nav"> <li><a href="#ios">iOS</a></li> <li><a href="#svn">SVN</a></li> <li class="dropdown"> <a href="#" id="navbarDrop1" class="dropdown-toggle" data-toggle="dropdown">Java <b class="caret"></b> </a> <ul class="dropdown-menu" role="menu" aria-labelledby="navbarDrop1"> <li><a href="#jmeter" tabindex="-1">jmeter</a></li> <li><a href="#ejb" tabindex="-1">ejb</a></li> <li class="divider"></li> <li><a href="#spring" tabindex="-1">spring</a></li> </ul> </li> </ul> </div> </div> </nav> <div data-spy="scroll" data-target="#navbar-example" data-offset="0" style="height:200px;overflow:auto; position: relative;"> <h4 id="ios">iOS</h4> <p>iOS est un système d'exploitation mobile développé et publié par Apple Inc. Il a été publié pour la première fois en 2007 avec l'iPhone original, l'iPod Touch et l'Apple TV. iOS est dérivé d'OS X, avec lequel il partage la base Darwin. OS X est utilisé sur les ordinateurs Apple, et iOS est la version mobile d'Apple.</p> <h4 id="svn">SVN</h4> <p>Apache Subversion, souvent abrégé en SVN, est un logiciel open source de gestion de versions. Subversion a été créé par CollabNet en 2000. Cependant, il est aujourd'hui devenu un projet de l'Apache Software Foundation, et dispose donc d'une riche communauté de développeurs et d'utilisateurs.</p> <h4 id="jmeter">jMeter</h4> <p>jMeter est un logiciel de test open source. C'est une application Java 100 % pure utilisée pour les tests de charge et de performance.</p> <h4 id="ejb">EJB</h4> <p>Enterprise Java Beans (EJB) est une architecture de développement pour créer des applications d'entreprise hautement évolutives et puissantes, déployées sur des serveurs d'applications compatibles J2EE (tels que JBOSS, Web Logic, etc.).</p> <h4 id="spring">Spring</h4> <p>Le Spring Framework est une plateforme Java open source qui fournit un support d'infrastructure complet pour développer rapidement des applications Java puissantes.</p> <p>Le Spring Framework a été initialement écrit par Rod Johnson et publié pour la première fois sous licence Apache 2.0 en juin 2003.</p> </div>

Essayez-le »

Le résultat est affiché ci-dessous :

滚动监听(Scrollspy)插件

Options

Ils peuvent être passés via des attributs data ou JavaScript. Le tableau ci-dessous répertorie ces options :

Nom de l'optionType/Valeur par défautNom de l'attribut de donnéesDescription
offsetnombre
Valeur par défaut : 10
data-offsetLe nombre de pixels de décalage à partir du haut lors du calcul de la position de défilement.

Méthodes

.scrollspy('refresh'): Lorsque vous appelez la méthode scrollspy via JavaScript, vous devez appeler.refreshla méthode pour mettre à jour le DOM. Ceci est très utile lorsque n'importe quel élément du DOM change (c'est-à-dire que vous avez ajouté ou supprimé des éléments). Voici la syntaxe d'utilisation de cette méthode.
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
})

Exemple

L'exemple suivant démontre.scrollspy('refresh')l'utilisation de la méthode :

Exemple

<nav id="myScrollspy" class="navbar navbar-default navbar-static" role="navigation"> <div class="container-fluid"> <div class="navbar-header"> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-scrollspy"> <span class="sr-only">Basculer la navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="#">Nom du tutoriel</a> </div> <div class="collapse navbar-collapse bs-js-navbar-scrollspy"> <ul class="nav navbar-nav"> <li class="active"><a href="#ios">iOS</a></li> <li><a href="#svn">SVN</a></li> <li class="dropdown"> <a href="#" id="navbarDrop1" class="dropdown-toggle" data-toggle="dropdown">Java <b class="caret"></b> </a> <ul class="dropdown-menu" role="menu" aria-labelledby="navbarDrop1"> <li><a href="#jmeter" tabindex="-1">jmeter</a></li> <li><a href="#ejb" tabindex="-1">ejb</a></li> <li class="divider"></li> <li><a href="#spring" tabindex="-1">spring</a></li> </ul> </li> </ul> </div> </div> </nav> <div data-spy="scroll" data-target="#myScrollspy" data-offset="0" style="height:200px;overflow:auto; position: relative;"> <div class="section"> <h4 id="ios">iOS<small><a href="#" onclick="removeSection(this);"> &times;Supprimer cette section</a></small> </h4> <p>iOS est un système d'exploitation mobile développé et publié par Apple Inc. Il a été initialement publié en 2007 pour iPhone, iPod Touch et Apple TV. iOS est dérivé d'OS X, et ils partagent la base Darwin. OS X est utilisé sur les ordinateurs Apple, tandis qu'iOS est la version mobile d'Apple.</p> </div> <div class="section"> <h4 id="svn">SVN<small></small></h4> <p>Apache Subversion, souvent abrégé en SVN, est un logiciel open source de gestion de versions. Subversion a été créé par CollabNet en 2000. Mais il est aujourd'hui devenu un projet de l'Apache Software Foundation, bénéficiant ainsi d'une riche communauté de développeurs et d'utilisateurs.</p> </div> <div class="section"> <h4 id="jmeter">jMeter<small><a href="#" onclick="removeSection(this);"> &times;Supprimer cette section</a></small> </h4> <p>jMeter est un logiciel de test open source. C'est une application Java 100% pure utilisée pour les tests de charge et de performance.</p> </div> <div class="section"> <h4 id="ejb">EJB</h4> <p>Enterprise Java Beans (EJB) est une architecture de développement permettant de créer des applications d'entreprise hautement évolutives et puissantes, déployées sur J2EE avec des serveurs d'applications compatibles (tels que JBOSS, Web Logic, etc.).</p> </div> <div class="section"> <h4 id="spring">Spring</h4> <p>Le framework Spring est une plateforme Java open source qui fournit un support d'infrastructure complet pour développer rapidement des applications Java puissantes.</p> <p>Le framework Spring a été initialement écrit par Rod Johnson et publié pour la première fois sous licence Apache 2.0 en juin 2003.</p> </div> </div> <script> $(function(){ removeSection = function(e) { $(e).parents(".section").remove(); $('[data-spy="scroll"]').each(function () { var $spy = $(this).scrollspy('refresh') }); } $("#myScrollspy").scrollspy(); }); </script>

Essayez-le vous-même »

Le résultat est le suivant :

滚动监听(Scrollspy)插件方法

Événements

Le tableau suivant répertorie les événements utilisés dans l'écoute du défilement. Ces événements peuvent être utilisés comme hooks dans des fonctions.

ÉvénementsDescriptionExemple
activate.bs.scrollspyCet événement est déclenché chaque fois qu'un nouvel élément est activé par l'écoute du défilement.
$('#myScrollspy').on('activate.bs.scrollspy', function () {
  // 执行一些动作...
})

Exemple

L'exemple suivant montreactivate.bs.scrollspyl'utilisation de l'événement :

Exemple

<nav id="myScrollspy" class="navbar navbar-default navbar-static" role="navigation"> <div class="container-fluid"> <div class="navbar-header"> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-scrollspy"> <span class="sr-only">Basculer la navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="#">Nom du tutoriel</a> </div> <div class="collapse navbar-collapse bs-js-navbar-scrollspy"> <ul class="nav navbar-nav"> <li class="active"><a href="#ios">iOS</a></li> <li><a href="#svn">SVN</a></li> <li class="dropdown"> <a href="#" id="navbarDrop1" class="dropdown-toggle" data-toggle="dropdown"> Java <b class="caret"></b> </a> <ul class="dropdown-menu" role="menu" aria-labelledby="navbarDrop1"> <li><a href="#jmeter" tabindex="-1">jmeter</a></li> <li><a href="#ejb" tabindex="-1">ejb</a></li> <li class="divider"></li> <li><a href="#spring" tabindex="-1">spring</a></li> </ul> </li> </ul> </div> </div> </nav> <div data-spy="scroll" data-target="#myScrollspy" data-offset="0" style="height:200px;overflow:auto; position: relative;"> <div class="section"> <h4 id="ios">iOS<small><a href="#" onclick="removeSection(this);"> &times;Supprimer cette section</a></small> </h4> <p>iOS est un système d'exploitation mobile développé et publié par Apple Inc. Il a été initialement publié en 2007 pour iPhone, iPod Touch et Apple TV. iOS est dérivé d'OS X, et ils partagent la base Darwin. OS X est utilisé sur les ordinateurs Apple, tandis qu'iOS est la version mobile d'Apple.</p> </div> <div class="section"> <h4 id="svn">SVN<small></small></h4> <p>Apache Subversion, souvent abrégé en SVN, est un logiciel open source de gestion de versions. Subversion a été créé par CollabNet en 2000. Mais il est aujourd'hui devenu un projet de l'Apache Software Foundation, bénéficiant ainsi d'une riche communauté de développeurs et d'utilisateurs.</p> </div> <div class="section"> <h4 id="jmeter">jMeter<small><a href="#" onclick="removeSection(this);"> &times;Supprimer cette section</a></small> </h4> <p>jMeter est un logiciel de test open source. C'est une application Java 100% pure utilisée pour les tests de charge et de performance.</p> </div> <div class="section"> <h4 id="ejb">EJB</h4> <p>Enterprise Java Beans (EJB) est une architecture de développement permettant de créer des applications d'entreprise hautement évolutives et puissantes, déployées sur J2EE avec des serveurs d'applications compatibles (tels que JBOSS, Web Logic, etc.).</p> </div> <div class="section"> <h4 id="spring">Spring</h4> <p>Le framework Spring est une plateforme Java open source qui fournit un support d'infrastructure complet pour développer rapidement des applications Java puissantes.</p> <p>Le framework Spring a été initialement écrit par Rod Johnson et publié pour la première fois sous licence Apache 2.0 en juin 2003.</p> </div> </div> <span id="activeitem" style="color:red;"></span> <script>$(function(){ removeSection = function(e) { $(e).parents(".section").remove(); $('[data-spy="scroll"]').each(function () { var $spy = $(this).scrollspy('refresh') }); } $("#myScrollspy").scrollspy(); $('#myScrollspy').on('activate.bs.scrollspy', function () { var currentItem = $(".nav li.active > a").text(); $("#activeitem").html("Currently you are viewing - " + currentItem); }) });</script>

Essayez-le vous-même »

Le résultat est le suivant :

滚动监听(Scrollspy)插件事件


Plus d’exemples

Création d'un Scrollspy horizontal

L'exemple suivant montre comment créer un scrollspy horizontal :

Exemple

<!-- La barre de navigation : utilisée pour accéder à une section dans la zone défilable -->
<nav class="navbar navbar-inverse navbar-fixed-top">
...
  <ul class="nav navbar-nav">
    <li><a href="#section1">Section 1</a></li>
    ...
</nav>

<!-- La zone défilable -->
<div data-spy="scroll" data-target=".navbar" data-offset="12">
  <!-- Section 1 -->
  <div id="section1">
    <h1>Section 1</h1>
    <p>Essayez de faire défiler cette page et regardez la barre de navigation pendant le défilement !</p>
  </div>
  ...
</div>

Essayez-le vous-même »

Comment créer un Scrollspy vertical

L'exemple suivant montre comment créer un scrollspy vertical :

Exemple

<body data-spy="scroll" data-target="#myScrollspy" data-offset="20">

  <div class="container">
    <div class="row">
      <nav class="col-sm-3" id="myScrollspy">
        <ul class="nav nav-pills nav-stacked">
          <li><a href="#section1">Section 1</a></li>
          ...
        </ul>
      </nav>
      <div class="col-sm-9">
        <div id="section1">
          <h1>Section 1</h1>
          <p>Essayez de faire défiler cette page et de regarder la liste de navigation pendant le défilement !</p>
        </div>
        ...
      </div>
    </div>
  </div>

</body>

Essayez-le vous-même »
Autres extensions