js實現(xiàn)文章目錄索引導(dǎo)航(table of content)
什么叫TOC呢?table of content。
具體什么效果呢?可以隨便找個hexo博客中體驗一下,例如這個。
好了,實現(xiàn)它有2個要點:
點目錄跳到段落:通過<a>標簽的錨點實現(xiàn),其原理在這里。
滾動觸發(fā)目錄變換:通過js監(jiān)聽滾動事件,判定當(dāng)前所處段落,令對應(yīng)目錄項高亮。
我寫了一個簡單的demo來演示這個效果,
源碼地址:https://github.com/owenliang/js-toc
在線體驗:http://owenliang.github.io/js-toc
實現(xiàn)分析
#toc是左側(cè)的目錄,#content是右側(cè)的文章正文。
<div id="toc"> <ul> </ul> </div> <div id="content"> <a name="seg-1" class="seg-begin"><h1>第1章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-2" class="seg-begin"><h1>第2章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-3" class="seg-begin"><h1>第3章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-4" class="seg-begin"><h1>第4章節(jié)</h1></a> <div class="seg-content"></div> </div>
利用css控制#toc靠左,當(dāng)前目錄高亮為紅色,正文則靠右填滿屏幕:
#toc { width: 200px; position: fixed; left: 0; top: 0; } #toc a.active { color: red; } #content { margin-left: 200px; }
在上面的靜態(tài)頁面中,目錄暫時為空,因為需要用JS動態(tài)生成。
正文中需要人工埋點段落起始標識,也就是a.seg-begin這樣的錨點,每個段落的錨點name唯一,而錨點之后緊隨段落的內(nèi)容。
在JS中,我首先按錨點的出現(xiàn)次序收集所有的a.seg-begin保存到segs數(shù)組中,其順序就是文章自上而下的閱讀順序,按照其<h1>中的段落標題建出#toc中的<ul>列表:
var segs = []; $(".seg-begin").each(function (idx, node) { segs.push(node) var link = $("<a></a>").attr("href", "#" + $(node).attr("name")).html($(node).children("h1").html()) if (!idx) { link.addClass("active") } var row = $("<li></li>").append(link) $("#toc ul").append(row) })
然后綁定瀏覽器的scroll事件進行監(jiān)聽,每次滾動就判斷最近一個滾出屏幕頂部的a.seg-begin節(jié)點,它就是當(dāng)前正在閱讀的段落:
$(window).bind("scroll", function() { var scrollTop = $(this).scrollTop() var topSeg = null for (var idx in segs) { var seg = segs[idx] if (seg.offsetTop > scrollTop) { continue } if (!topSeg) { topSeg = seg } else if (seg.offsetTop >= topSeg.offsetTop) { topSeg = seg } } if (topSeg) { $("#toc a").removeClass("active") var link = "#" + $(topSeg).attr("name") console.log('#toc a[href="' + link + '" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ]') $('#toc a[href="' + link + '" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ]').addClass("active") // console.log($(topSeg).children("h1").text()) } })
后續(xù)
這里目錄的生成是在前端JS里根據(jù)正文的錨點動態(tài)生成的,為了SEO可以在后端提交文章正文時匹配出這些錨點,直接保存為目錄。
完整代碼
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <style> * { margin: 0; padding: 0; word-break: break-all; } #toc { width: 200px; position: fixed; left: 0; top: 0; } #toc a.active { color: red; } #content { margin-left: 200px; } </style> <script src="https://cdn.bootcss.com/jquery/3.2.1/jquery.min.js"></script> <script> $(document).ready(function () { for (var i = 0; i < 50; ++i) { $(".seg-content").append("<p>一個段落而已</p>") } (function () { var segs = []; $(".seg-begin").each(function (idx, node) { segs.push(node) var link = $("<a></a>").attr("href", "#" + $(node).attr("name")).html($(node).children("h1").html()) if (!idx) { link.addClass("active") } var row = $("<li></li>").append(link) $("#toc ul").append(row) }) $(window).bind("scroll", function() { var scrollTop = $(this).scrollTop() var topSeg = null for (var idx in segs) { var seg = segs[idx] if (seg.offsetTop > scrollTop) { continue } if (!topSeg) { topSeg = seg } else if (seg.offsetTop >= topSeg.offsetTop) { topSeg = seg } } if (topSeg) { $("#toc a").removeClass("active") var link = "#" + $(topSeg).attr("name") console.log('#toc a[href="' + link + '" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ]') $('#toc a[href="' + link + '" rel="external nofollow" rel="external nofollow" rel="external nofollow" rel="external nofollow" ]').addClass("active") // console.log($(topSeg).children("h1").text()) } }) })() }) </script> </head> <body> <div id="toc"> <ul> </ul> </div> <div id="content"> <a name="seg-1" class="seg-begin"><h1>第1章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-2" class="seg-begin"><h1>第2章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-3" class="seg-begin"><h1>第3章節(jié)</h1></a> <div class="seg-content"></div> <a name="seg-4" class="seg-begin"><h1>第4章節(jié)</h1></a> <div class="seg-content"></div> </div> </body> </html>
另外,這里沒有實現(xiàn)嵌套的目錄結(jié)構(gòu),我特意觀察了一下hexo的做法,是通過h1,h2,h3來表達層級的,這樣在each遍歷生成目錄的時候可以基于這個信息完成嵌套層級的標記,問題迎刃而解。
相關(guān)文章
js將long日期格式轉(zhuǎn)換為標準日期格式實現(xiàn)思路
本文為大家詳細介紹下js將long日期格式轉(zhuǎn)換為標準日期格式,感興趣的朋友可以參考下哈,希望可以幫助到你2013-04-04onsubmit阻止form表單提交與onclick的相關(guān)操作
return false會阻止表單提交,基本上關(guān)于onsubmit=return false有以下幾點要注意的地方,學(xué)習(xí)后臺編程的朋友一定要知道。2010-09-09基于JavaScript實現(xiàn)移動端TAB觸屏切換效果
我們使用移動端時可以通過觸屏手勢左右滑動來切換TAB欄目,如網(wǎng)易新聞等APP欄目切換。我們說的TAB一般由導(dǎo)航條和TAB對應(yīng)的內(nèi)容組成,切換導(dǎo)航條上的標簽同時標簽對應(yīng)的內(nèi)容也會跟著切換。本文將結(jié)合實例給大家介紹一個移動端TAB觸屏切換效果。2015-10-10