Scrollspy 會依據捲動位置自動更新對應的導覽項目,最常見的應用就是長頁面側邊目錄的「目前位置」高亮。
<!DOCTYPE html>
<html>
<head>
<title>Bootstrap Scrollspy</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="css/bootstrap.min.css" rel="stylesheet" media="screen">
<style type="text/css">
.scrollspy-example {
height: 200px;
overflow: auto;
position: relative; /* 必須有定位,offset 計算才正確 */
border: 1px solid red;
}
</style>
</head>
<body>
<div class="container">
<nav id="navbar-example" class="navbar navbar-default navbar-static">
<div class="navbar-header">
<a class="navbar-brand" href="#">Project Name</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav">
<li class="active"><a href="#fat">@fat</a></li>
<li><a href="#mdo">@mdo</a></li>
<li><a href="#one">one</a></li>
</ul>
</div>
</nav>
<div data-offset="0" class="scrollspy-example"
data-spy="scroll" data-target="#navbar-example">
<h4 id="fat">@fat</h4>
<p>……內容……</p>
<h4 id="mdo">@mdo</h4>
<p>……內容……</p>
<h4 id="one">one</h4>
<p>……內容……</p>
</div>
</div>
<script src="js/jquery-2.0.3.min.js"></script>
<script src="js/bootstrap.min.js"></script>
</body>
</html>
在要監聽的捲動容器上加 data-spy="scroll",再用 data-target 指向導覽元件(.nav 之類)的父元素的 id 或 class:
<div data-offset="0" class="scrollspy-example"
data-spy="scroll" data-target="#navbar-example">
......
</div>
必要條件:導覽連結的 href="#xxx" 必須在頁面中存在同 id 的目標元素,否則該項目永遠不會被啟用。
<script type="text/javascript">
$(function () {
$('.scrollspy-example').scrollspy({ target: '#navbar-example' });
});
</script>
當頁面內容動態增刪 DOM 後,必須呼叫 refresh 重新計算各區塊位置,否則高亮會偏移:
$('[data-spy="scroll"]').each(function () {
var $spy = $(this).scrollspy('refresh');
});
選項可透過 data 屬性或 JavaScript 傳入;使用 data 屬性時,名稱前加 data-,例如 data-offset="200"。其中 offset 是「距離頂端多少像素才算進入該區塊」的偏移量,預設 10,若你的頁面有固定高度的頁首,通常需要調大以避免位置提前切換。

$('#navbar-example').on('activate.bs.scrollspy', function () {
// 每次高亮項目變動時觸發
});
被監聽的容器必須真的有捲軸,否則 scrollspy 無從觸發。因此記得給它高度與 overflow:auto:
.scrollspy-example {
height: 200px;
overflow: auto;
position: relative;
}
另外,Bootstrap 3 的 scrollspy 監聽的是「容器自身的捲動」;若你想監聽整個頁面的捲動,應把 data-spy 放在 <body> 上,並搭配 position:relative 的 body 樣式。