為什麼需要自動目錄
寫長文時,段落標題一多,讀者要在章節之間來回滑動就很累。手動維護目錄與錨點更是苦差事——標題一改,編號和連結全得跟著改。比較聰明的做法是:用程式掃描標題、自動產生錨點與選單,再靠 Bootstrap 的 Affix 外掛把目錄釘在側邊,滾動時還能自動高亮當前章節。Bootstrap 官方文件本身就是這樣做的。
準備工作
先把 bootstrap.min.js 放進 body 尾的 script 標籤中(uikit.min.js 先不急著載入,後面會說明時機)。整體思路分三步:先依文章內容自動產生錨點與選單,接著掛上 Affix 讓目錄固定,最後用 scrollSpy 類的外掛做滾動監聽。
認識 Affix
Affix 的作用是固定元素位置,並依滾動狀況動態加位移,讓元素在三種 class 之間切換:
1. affix-top:位於頂端時的狀態
2. affix:頁面滾動後加上 fixed 定位,搭配自訂的 offset 偏移量
3. affix-bottom:抵達頁面最底部時的狀態
啟用方式很簡單:
$('#nav').affix({ offset: { top:$('header').offset().top, bottom: ($('footer').outerHeight(true) + $('.application').outerHeight(true)) + 40 } });
一、HTML 結構
<ul id="mysidebar" class="nav affix" > </ul>
關鍵是 ul 上必須同時有 nav 和 affix 兩個 class。
二、封裝成 jQuery 外掛
;$.fn.extend({ "createAffix": function(selector) { $list = $("" + selector), length = $list.length, affixValue = ""; for (var i = 0; i < length; i++) { //給每一個標題增加name屬性 $list.eq(i).attr("id", ("node" + i)); var text = $list.eq(i).text(); if (i == 0) { affixValue += "<li><a href=#node" + i + " class='active' >" + text + "</a></li>"; } else { affixValue += "<li><a href=#node" + i + ">" + text + "</a></li>"; } } this.append(affixValue); this.affix({ offset: { top: this.offset().top//在固定之後距離頂部的偏移量 } }); return this; } });
原理是傳入「哪些元素算標題」這個選擇器,迴圈中依序為它們補上 id,並把文字拼成選單項目 append 進容器,最後順手掛上 affix。
三、使用方式
<ul id="mysidebar" class="nav affix" > <li><a href="#node1"></a></li> <li><a href="#node2"></a></li> <li><a href="#node3"></a></li> </ul> <h3 id="node1">標題1</h3> <h3 id="node2">標題2</h3> <h3 id="node3">標題3</h3>
$(function(){ $(' #mysidebar').createAffix('h3'); //表示在文章中,使用`h3`標簽的是 需要被添加錨點的地方。 });
處理錨點被頂欄遮住的問題
錨點預設會把目標元素推到視窗最頂端,如果頁首有固定選單欄,標題就會被蓋住。用 padding 加負 margin 的組合可以把它頂下來:
.class{ /* 添加padding可以讓錨點向下偏移num px,也就是跳過菜單欄的高度, 通過設置margin-top為負值來`彌補`因為padding-top帶來的空白部分 */ padding-top: num px; margin-top: -num px; }
加上滾動監聽
目前 DOM 長這樣:
<ul id="mysidebar" class="nav affix" > <li><a href="#node1"></a></li> <li><a href="#node2"></a></li> <li><a href="#node3"></a></li> </ul>
加工一下,補上 uikit 的屬性(細節可查官方文件):
<ul id="mysidebar" class="nav affix uk-nav uk-nav-side" data-uk-scrollspy-nav="{closest:'li',smoothscrool:true}" > <li><a href="#node1"></a></li> <li><a href="#node2"></a></li> <li><a href="#node3"></a></li> </ul>
最後載入 uikit.min.js
這裡有個順序陷阱:選單項目是文件載入後才由 JS 產生的,如果在選單還不存在的時候就先跑 scrollSpy,監聽自然綁不到任何東西。所以務必等 createAffix 執行完再動態載入:
$(function(){ $(' #mysidebar').createAffix('h3');//生成菜單 $.getScript("uikit.min.js");//異步載入uikit.min.js,滾動監聽生效。 });
做到這一步,一個會自動產生、固定懸浮、並隨滾動高亮的文章目錄就完成了。