js实现文章目录索引导航(table of content)
什么叫TOC呢?table of content。
具体什么效果呢?可以随便找个hexo博客中体验一下,例如这个。
好了,实现它有2个要点:
点目录跳到段落:通过<a>标签的锚点实现,其原理在这里。
滚动触发目录变换:通过js监听滚动事件,判定当前所处段落,令对应目录项高亮。
我写了一个简单的demo来演示这个效果,
源码地址:https://github.com/owenliang/js-toc
在线体验:http://owenliang.github.io/js-toc
实现分析
#toc是左侧的目录,#content是右侧的文章正文。
<div id="toc"> <ul> </ul> </div> <div id="content"> <a name="seg-1" class="seg-begin"><h1>第1章节</h1></a> <div class="seg-content"></div> <a name="seg-2" class="seg-begin"><h1>第2章节</h1></a> <div class="seg-content"></div> <a name="seg-3" class="seg-begin"><h1>第3章节</h1></a> <div class="seg-content"></div> <a name="seg-4" class="seg-begin"><h1>第4章节</h1></a> <div class="seg-content"></div> </div>
利用css控制#toc靠左,当前目录高亮为红色,正文则靠右填满屏幕:
#toc { width: 200px; position: fixed; left: 0; top: 0; } #toc a.active { color: red; } #content { margin-left: 200px; }
在上面的静态页面中,目录暂时为空,因为需要用JS动态生成。
正文中需要人工埋点段落起始标识,也就是a.seg-begin这样的锚点,每个段落的锚点name唯一,而锚点之后紧随段落的内容。
在JS中,我首先按锚点的出现次序收集所有的a.seg-begin保存到segs数组中,其顺序就是文章自上而下的阅读顺序,按照其<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事件进行监听,每次滚动就判断最近一个滚出屏幕顶部的a.seg-begin节点,它就是当前正在阅读的段落:
$(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()) } })
后续
这里目录的生成是在前端JS里根据正文的锚点动态生成的,为了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章节</h1></a> <div class="seg-content"></div> <a name="seg-2" class="seg-begin"><h1>第2章节</h1></a> <div class="seg-content"></div> <a name="seg-3" class="seg-begin"><h1>第3章节</h1></a> <div class="seg-content"></div> <a name="seg-4" class="seg-begin"><h1>第4章节</h1></a> <div class="seg-content"></div> </div> </body> </html>
另外,这里没有实现嵌套的目录结构,我特意观察了一下hexo的做法,是通过h1,h2,h3来表达层级的,这样在each遍历生成目录的时候可以基于这个信息完成嵌套层级的标记,问题迎刃而解。
原文链接:https://yuerblog.cc/2017/12/04/js-toc/
(资源库 www.zyku.net)
栏 目:JavaScript
下一篇:js中!和!!的区别与用法
本文标题:js实现文章目录索引导航(table of content)
本文地址:https://www.zyku.net/js/1903.html
您可能感兴趣的文章
- 09-27帝国CMS系统内置标签语法介绍
- 11-21mysql修改character_set_server为utf-
- 11-21PHP运算符
- 12-16安装wamp后,127.0.0.1可以访问,但是loca
- 12-27PHP :Call to undefined function mys
- 02-28CentOS 6.4下安装MySQL后重置root密码
- 03-27html 中input标签的隐藏方法
- 04-16帝国CMS去掉注册会员“选择注册会员类
- 05-16DeDeCms内容上传的图片禁止新窗口打开
- 07-10帝国cms后台忘记了安全提问及密码该如
- 07-15帝国CMS实现会员每天登陆实现赠送积分
- 07-15帝国ECMS6.5灵动标签汇集
- 07-15帝国cms:首页调用留言板内容截取字数
- 07-15帝国下载地址可以使用直接地址不用跳
- 07-15帝国CMS反馈信息发送邮件提醒到管理员
- 08-10利用PHP生成随机密码的几种方法
- 01-12织梦dedecms gbk站点转utf8之mip改造
- 01-12用dedecms实现拼音显示文章标题页文件
- 01-13dedeCMS使用list标签调用文章日期的方
- 01-13dedecms调用栏目名称与栏目链接地址的
阅读排行
猜你喜欢
- 09-26text-indent首行缩进两个字符和图片缩
- 10-12帝国CMS目录结构介绍
- 11-21推荐29个Sublime Text常用插件
- 11-21PHP中判断一个数是否为素数的方法
- 11-22Apache的安装、配置及卸载
- 11-28Apache隐藏版本号及其它敏感信息
- 02-21Linux中删除文件功能详解
- 02-22Nginx 禁止IP访问的方法
- 02-24nginx+php 打开php错误提示的方法
- 02-25Cookies 和 Session的区别