Bootstrap JS Scrollspy
JS Scrollspy (scrollspy.js)
Wtyczka Scrollspy służy do automatycznego aktualizowania linków na liście nawigacyjnej na podstawie pozycji przewijania.
Samouczek dotyczący Scrollspy znajdziesz w naszym samouczku Bootstrap Scrollspy .
Wskazówka: Wtyczka Scrollspy jest często używana razem z wtyczką Affix .
Przez dane-* Atrybuty
Dodaj data-spy="scroll"
do elementu, który ma być używany jako obszar przewijany (często jest to <body>
element).
Następnie dodaj data-target
atrybut z wartością identyfikatora lub nazwą klasy paska nawigacyjnego ( .navbar
). Ma to na celu upewnienie się, że pasek nawigacyjny jest połączony z obszarem przewijania.
Zwróć uwagę, że elementy przewijalne muszą odpowiadać identyfikatorom łączy w elementach listy paska nawigacyjnego ( <div id="section1">
pasuje <a href="#section1">
).
Atrybut opcjonalny data-offset
określa liczbę pikseli do przesunięcia od góry podczas obliczania pozycji przewijania. Jest to przydatne, gdy czujesz, że linki w pasku nawigacyjnym zmieniają stan aktywny zbyt wcześnie lub zbyt wcześnie podczas przechodzenia do przewijalnych elementów. Wartość domyślna to 10 pikseli.
Wymaga względnego pozycjonowania: element z data-spy="scroll" do poprawnego działania wymaga właściwości CSS position o wartości "relative".
Przykład
<!-- 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-inverse navbar-fixed-top">
...
<ul class="nav
navbar-nav">
<li><a href="#section1">Section 1</a></li>
...
</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>
Przez JavaScript
Włącz ręcznie za pomocą:
Przykład
$('body').scrollspy({target: ".navbar"})
Opcje Scrollspy
Opcje można przekazywać za pomocą atrybutów danych lub JavaScript. W przypadku atrybutów danych dołącz nazwę opcji do data-, tak jak w 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 |
Metody Scrollspy
W poniższej tabeli wymieniono wszystkie dostępne metody scrollspy.
Method | Description | Try it |
---|---|---|
.scrollspy("refresh") | When adding and removing elements from the scrollspy, this method can be used to refresh the document |
Wydarzenia Scrollspy
Poniższa tabela zawiera listę wszystkich dostępnych zdarzeń scrollspy.
Event | Description | Try it |
---|---|---|
activate.bs.scrollspy | Occurs when a new item becomes activated by the scrollspy |
Więcej przykładów
Scrollspy z animowanym przewijaniem
Jak dodać płynny przewijanie strony do kotwicy na tej samej stronie:
Płynne przewijanie
// Add scrollspy to <body>
$('body').scrollspy({target: ".navbar", offset: 50});
// Add smooth scrolling on all links inside the navbar
$("#myNavbar a").on('click', function(event) {
// Make sure this.hash has a value before overriding default behavior
if (this.hash !== "") {
// Prevent default anchor click behavior
event.preventDefault();
// Store hash
var hash = this.hash;
// Using jQuery's animate() method to add smooth page scroll
// The optional number (800) specifies the number of milliseconds it takes to scroll to the specified area
$('html, body').animate({
scrollTop: $(hash).offset().top
}, 800, function(){
// Add hash (#) to URL when done scrolling (default click behavior)
window.location.hash = hash;
});
} // End if
});
Scrollspy i afiks
Korzystanie z wtyczki Affix razem z wtyczką Scrollspy:
Menu poziome (pasek nawigacyjny)
<body data-spy="scroll" data-target=".navbar" data-offset="50">
<nav class="navbar navbar-inverse" data-spy="affix" data-offset-top="197">
...
</nav>
</body>
Menu pionowe (Sidenav)
<body data-spy="scroll" data-target="#myScrollspy" data-offset="15">
<nav class="col-sm-3" id="myScrollspy">
<ul class="nav nav-pills nav-stacked" data-spy="affix" data-offset-top="205">
...
</nav>
</body>