Scrollspy(滾動監聽)能讓導航隨滾動自動定位並高亮當前所處的內容區塊。本文從使用約束到源碼實現完整講解。
scrollspy.js
1. 當滾動區域內某 hashkey 錨點到達有效位置時,關聯並高亮導航上的指定項;
2. 導航必須是 .nav > li > a 結構,且 a 的 href 或 data-target 要綁定 hashkey;
3. 菜單必須帶有 .nav 樣式;
4. 滾動區域的 data-target 要與導航父級 Id 一致(一定是父級)。
<div id="selector" class="navbar navbar-default"> <ul class="nav navbar-nav"> <li><a href="#one">one</a> </li> <li><a href="#two">two</a> </li> <li><a href="#three">three</a> </li> </ul> </div> <div data-spy="scroll" data-target="#selector" style="height:100px; overflow:hidden;overflow-y: auto;" > <h4 id="one" >ibe</h4><p>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/></p> <h4 id="two" >two</h4><p>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/></p> <h4 id="three" >three</h4><p>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/>One的具體內容<br/></p> </div>
1. 原理:當容器內 hashkey 距容器頂部只剩 offset 設置的值時,就高亮導航中對應的 href。
2. 若滾動區域是 body,會將滾動元素標記為 window(構造函數中判斷):
this.$scrollElement = $(element).is(document.body) ? $(window) : $(element)
3. getScrollHeight:獲取容器內容高度(含隱藏部分):
this.$scrollElement[0].scrollHeight || Math.max(this.$body[0].scrollHeight, document.documentElement.scrollHeight)
4. refresh:刷新並存儲各 hashkey 的定位值。默認用 offset,若滾動區域不是 window 則用 position:
if (!$.isWindow(this.$scrollElement[0])) { offsetMethod = 'position' offsetBase = this.$scrollElement.scrollTop() }
根據導航 hashkey 遍歷獲取對應元素的 offset:
this.$body .find(this.selector) .map(function () { var $el = $(this) var href = $el.data('target') || $el.attr('href') var $href = /^#./.test(href) && $(href) return ($href && $href.length && $href.is(':visible') && [[$href[offsetMethod]().top + offsetBase, href]]) || null }) .sort(function (a, b) { return a[0] - b[0] }) .each(function () { that.offsets.push(this[0]) that.targets.push(this[1]) })
5. process:滾動事件觸發的計算函數,判斷當前應高亮哪個菜單。先取已滾動距離:
var scrollTop = this.$scrollElement.scrollTop() + this.options.offset
再算最大可滾動高度:
var maxScroll = this.options.offset + scrollHeight - this.$scrollElement.height()
設置活動項的邏輯:
for (i = offsets.length; i--;) { if (activeTarget != targets[i] && scrollTop >= offsets[i] && (offsets[i + 1] === undefined || scrollTop < offsets[i + 1])) { return this.activate(targets[i]) } }
6. activate:設置指定導航菜單高亮。
7. clear:清除所有高亮菜單。
想進一步深入學習,可延伸閱讀 Bootstrap 學習教程、實戰教程與插件使用教程。希望本文對你學習 JavaScript 程序設計有所幫助。