Bootstrap JS Scrollspy


JS Scrollspy

Scrollspy est utilisé pour mettre à jour automatiquement les liens dans une liste de navigation en fonction de la position de défilement.

Pour un tutoriel sur Scrollspy, lisez notre Tutoriel Bootstrap Scrollspy .


Via data-* Attributs

Ajoutez data-spy="scroll"à l'élément qui doit être utilisé comme zone de défilement (il s'agit souvent de l' <body>élément).

Ajoutez ensuite l' data-targetattribut avec une valeur de l'id ou du nom de classe de la barre de navigation ( .navbar). Cela permet de s'assurer que la barre de navigation est connectée à la zone de défilement.

Notez que les éléments déroulants doivent correspondre à l'ID des liens à l'intérieur des éléments de liste de la barre de navigation ( <div id="section1">matches <a href="#section1">).

data-offsetL' attribut facultatif spécifie le nombre de pixels à décaler du haut lors du calcul de la position du défilement. Ceci est utile lorsque vous sentez que les liens à l'intérieur de la barre de navigation changent l'état actif trop tôt ou trop tôt lors du saut vers les éléments défilants. La valeur par défaut est 10 pixels.

Nécessite un positionnement relatif : L'élément avec data-spy="scroll" nécessite la propriété CSS position , avec une valeur de "relative" pour fonctionner correctement.

Exemple

<!-- The scrollable area -->
<body data-spy="scroll" data-target=".navbar" data-offset="50">

<!-- The navbar - The <a> elements are used to jump to a section in the scrollable area -->
<nav class="navbar navbar-expand-sm bg-dark navbar-dark fixed-top">
  <ul class="navbar-nav">
    <li class="nav-item">
      <a class="nav-link" href="#section1">Section 1</a>
    </li>
  ....
  </ul>
</nav>

<!-- Section 1 -->
<div id="section1">
  <h1>Section 1</h1>
  <p>Try to scroll this page and look at the navigation bar while scrolling!</p>
</div>
...

</body>

Via Javascript

Activer manuellement avec :

Exemple

$('body').scrollspy({target: ".navbar"})

Options d'espionnage de défilement

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

Name Type Default Description Try it
offset number 10 Specifies the number of pixels to offset from top when calculating the position of scroll

Méthodes Scrollspy

Le tableau suivant répertorie toutes les méthodes scrollspy disponibles.

Method Description
.scrollspy("refresh") When adding and removing elements from the scrollspy, this method can be used to refresh the document
.scrollspy("dispose") Destroys the scrollspy

Événements d'espionnage

Le tableau suivant répertorie tous les événements scrollspy disponibles.

Event Description
activate.bs.scrollspy Occurs when a new item becomes activated by the scrollspy