DIV CSS 佈局教程網

源碼剖析 Bootstrap 滾動偵聽插件 scrollspy.js
編輯:關於JavaScript     

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 滾動偵聽插件源碼的完整梳理,理解它對理解 offset、滾動距離與菜單狀態的協同很有幫助。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved