使用Affix和ScrollSpy插件动态生成你的文章内部目录

引言

在写博客的时候，为了条理性起见，经常会使用许多小标题，当文章长时，需要来回在不同的标题之间穿梭，如果手动添加目录，添加锚点，实在是麻烦，为此，可以动态生成一块目录区域，并使用Bootstrap提供的Affix插件将目录区域固定在页面上。Bootstrap文档便使用了它

准备工作-引入bootstrap.min.js

• 将bootstrap.min.js放入body之前的script标签中，uikit.min.js暂时不引入。
  引入相关插件之后，我们的思路是首先根据文章自动生成锚点以及菜单内容，随后为其添加Affix产生固定效果，再使用uikit的scrollSpy插件(bootstrap中也有scrollspy,使用方法几乎一致)。

引-学习Affix的使用

Affix插件尅帮助我们固定导航部分的位置，并且根据用户的滚动情况来为固定的元素增加垂直偏移量，使得nav在三个类之间进行切换：
1.affix-top:表示在顶端
2.affix:表示在页面滚动，增加fixed属性，同时使用自定义的offset偏移量
3.affix-bottom:表示到达最底端

启用Affix只需要以下代码：

$('#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类。

二、生成封装代码

将本代码段引入到你自己的script脚本中

  ;$.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;
        }
    
  });

上述代码的原理是为createAffix函数传入需要被认为是标题单元的标签或者类，在遍历过程中为其增加锚点链接。

三、使用方法

书写HTML部分

  <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>

书写Javascript部分

  $(function(){
  $(' #mysidebar').createAffix('h3');
  //表示在文章中，使用`h3`标签的是  需要被添加锚点的地方。
  });

解决锚点偏移的问题

因为锚点默认将页面偏移到锚点元素的顶部，也就是如果我们对标题1进行了上述操作，当我们点击锚点时，页面会偏移到'标题1'所在的顶端位置，如果顶端有菜单栏，那么将会被遮住，通过设置css样式来解决。

.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

由于我们的菜单项(li)是在文档加载后执行的，那么如果在生成菜单项之前变执行uikit的scrollspy，那么必定不起作用，所以要在菜单项生成后引入uikit.min.js，代码如下：

$(function(){
$(' #mysidebar').createAffix('h3');//生成菜单
$.getScript("uikit.min.js");//异步载入uikit.min.js，滚动监听生效。
});