前边的话

  滚动监听插件是用来依据滚动条所处的职位来自动更新导航项的。滚动导航条下边包车型客车区域并关怀导航项的浮动,下拉菜单中的条目也会自行高亮显示。本文将详细介绍Bootstrap滚动监察和控制器

 

主导用法

  滚动监听插件是依照滚动的职位自动更新导航条中相应的领航项的,该插件可自动物检疫查测试达到哪个岗位了,然后在须求高亮的菜单父成分上加了三个active样式

  如酚酞航里有下拉菜单,并且滚动区域的剧情到达下拉菜单子项所对应的区域,除了子菜单高亮之外,子菜单的父元素(dropdown按钮)也会高亮

  在平日选拔的进度中,滚动监听壹般有两种用法,一种是永世一个要素的莫斯科大学,举办滚动,然后对相应的菜单进行高亮突显;其它一种是对全部页面(body)举行滚动监听。二种办法的用法同样,都亟需有如下3个步骤:

  一、设置滚动容器,即在所要监听的成分上设置data-target=”#selector”
data-spy=”scroll”属性

  贰、设置菜单链接容器,该容器的id(或样式)和data-target属性所对应的选拔符要壹致

  三、在菜单容器内,必须有.nav样式的成分,并且在其剧情有li成分,li内含有的a成分也是可以侦测高亮的菜单链接,即符合.nav
li > a那种采取符的标准

  四、无论何种落成格局,滚动监听都亟待被监听的机件是 position: relative; 即相对固定情势

【固定成分低度】

<div id="myNavbar" class="navbar navbar-default navbar-fixed-top" role="navigation" style="position:relative">
     <ul class="nav navbar-nav">
        <li><a href="#html" tabindex="-1">HTML</a></li>
        <li><a href="#css" tabindex="-1">CSS</a></li>
        <li><a href="#javascript" tabindex="-1">javascript</a></li>
     </ul>
</div>

<div data-spy="scroll" data-target="#myNavbar" style="margin-top:150px;height:250px;overflow:auto;position:relative">
    <h4 id="html">Html</h4>
    <p>Html内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="css">CSS</h4>
    <p>CSS内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="javascript">javascript</h4>
    <p>javascript内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p>
</div>

【body元素】

<body data-spy="scroll" data-target="#myNavbar" style="height:300px;position:relative">

<div id="myNavbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
     <ul class="nav navbar-nav">
        <li><a href="#html" tabindex="-1">HTML</a></li>
        <li><a href="#css" tabindex="-1">CSS</a></li>
        <li><a href="#javascript" tabindex="-1">javascript</a></li>
     </ul>
</div>

<h4 id="html" style="margin-top:150px">Html</h4>
<p>Html内容</p>
<br><p>...</p><br><p>...</p><br><p>...</p>
<h4 id="css">CSS</h4>
<p>CSS内容</p>
<br><p>...</p><br><p>...</p><br><p>...</p>
<h4 id="javascript">javascript</h4>
<p>javascript内容</p>
<br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p>

</body>

 

jQuery,JS调用

  在Bootstrap框架中,使用JavaScript方法触发滚动监控器绝对来说较为简单,只必要钦点四个容器的名称就可以

<div id="myNavbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
     <ul class="nav navbar-nav">
        <li><a href="#html" tabindex="-1">HTML</a></li>
        <li><a href="#css" tabindex="-1">CSS</a></li>
        <li><a href="#javascript" tabindex="-1">javascript</a></li>
     </ul>
</div>
<div id="scrollspy"  style="margin-top:150px;height:250px;overflow:auto;position:relative">
    <h4 id="html">Html</h4>
    <p>Html内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="css">CSS</h4>
    <p>CSS内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="javascript">javascript</h4>
    <p>javascript内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p>
</div>
<script>
$('#scrollspy').scrollspy({ target: '#myNavbar' })    
</script>

 

方法

  当使用滚动监听插件的同时在 DOM
中增添或删除成分后,必要像上边那样调用此刷新( refresh) 方法 

$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
})

  要留意的是,那种refresh方法只对注解式用法有效。如若选择的是JS触发,并且要求刷新DOM,则须要再一次使用该插件;大概从data-scrollspy属性上获得该实例,然后再调用refresh方法

【参数】

  能够透过 data 属性或 JavaScript 传递参数。对于 data
属性,其名目是将参数名附着到 data- 前面组成,例如 data-offset=""

  滚动监察和控制提供了一个offset参数,此参数私下认可值为十。默认意况下,滚动内容距离滚动容器10px之内的话,就高亮突显所对应的菜单项

【事件】

  滚动监控也扶助事件的订阅和接触效用,近日只援救2个activate事件

activate.bs.scrollspy    每当一个新条目被激活后都将由滚动监听插件触发此事件。

<div id="myNavbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
     <ul class="nav navbar-nav">
        <li><a href="#html" tabindex="-1">HTML</a></li>
        <li><a href="#css" tabindex="-1">CSS</a></li>
        <li><a href="#javascript" tabindex="-1">javascript</a></li>
     </ul>
</div>
<div id="scrollspy" data-spy="scroll" data-target="#myNavbar"  data-offset="0" style="margin-top:150px;height:250px;overflow:auto;position;relative">
    <h4 id="html">Html</h4>
    <p>Html内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="css">CSS</h4>
    <p>CSS内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p>
    <h4 id="javascript">javascript</h4>
    <p>javascript内容</p>
    <br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p><br><p>...</p>
</div>
<script>
$(function(){
    $("#myNavbar").on('activate.bs.scrollspy',function(e){
        $(e.target).siblings().css('outline','none')
            .end().css('outline','1px solid black');    
    })
})    
</script>

 

JS源码

【1】IIFE

  使用即时调用函数,幸免插件内代码外泄,从而变成3个闭环,并且只可以从jQuery的fn里进行扩充

+function ($) {
    //使用es5严格模式
    'use strict';
    //
}(window.jQuery);

【贰】开端设置

  function ScrollSpy(element, options) {
    this.$body          = $(document.body)
    //判断滚动容器是否是body,如果是则使用window,如果不是则使用该元素本身
    this.$scrollElement = $(element).is(document.body) ? $(window) : $(element)
    //将默认值和传进来的options参数合并,后者优先级高
    this.options        = $.extend({}, ScrollSpy.DEFAULTS, options)
    //如果option里设置了target,即data-target有值,则优先使用
    //如果没有,则查找通过.nav样式的子元素,即.nav样式内的li子元素内的a链接,作为菜单容器
    this.selector       = (this.options.target || '') + ' .nav li > a'
    this.offsets        = []
    this.targets        = []
    //高亮显示的菜单
    this.activeTarget   = null
    this.scrollHeight   = 0
    //给滚动容器绑定滚动事件
    this.$scrollElement.on('scroll.bs.scrollspy', $.proxy(this.process, this))
    //计算当前页面内所有滚动容器内的id集合和每个id元素距离浏览器顶部的像素距离
    this.refresh()
    //开始正式处理
    this.process()
  }
  //版本是3.3.7
  ScrollSpy.VERSION  = '3.3.7'
  //默认值为offset:10
  ScrollSpy.DEFAULTS = {
    offset: 10
  }

【3】插件主旨代码

  //获取滚动容器的滚动高度
  ScrollSpy.prototype.getScrollHeight = function () {
    //获取特定滚动容器的滚动高度,如果没有则获取body元素的滚动高度
    return this.$scrollElement[0].scrollHeight || Math.max(this.$body[0].scrollHeight, document.documentElement.scrollHeight)
  }

  ScrollSpy.prototype.refresh = function () {
    var that          = this
    var offsetMethod  = 'offset'
    var offsetBase    = 0

    this.offsets      = []
    this.targets      = []
    this.scrollHeight = this.getScrollHeight()

    if (!$.isWindow(this.$scrollElement[0])) {
      offsetMethod = 'position'
      offsetBase   = this.$scrollElement.scrollTop()
    }

    this.$body
      .find(this.selector)
      .map(function () {
        var $el   = $(this)
        var href  = $el.data('target') || $el.attr('href')
        var $href = /^#./.test(href) && $(href)
        //返回一个二维数组,每个滚动容器内的id对象到页面顶部的距离以及高亮菜单容器里所对应的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 () {
        //收集所有的偏移值,也就是距离top的距离
        that.offsets.push(this[0])
        //收集菜单容器里的所有href值,也就是滚动容器里的id值
        that.targets.push(this[1])
      })
  }

  ScrollSpy.prototype.process = function () {
    //获取滚动容器的scrollTop,再加上设置的offset值
    var scrollTop    = this.$scrollElement.scrollTop() + this.options.offset
    //获取滚动高度
    var scrollHeight = this.getScrollHeight()
    //最大滚动=总scrollheight + 设置的offset值 - 设置高度height
    var maxScroll    = this.options.offset + scrollHeight - this.$scrollElement.height()
    var offsets      = this.offsets
    var targets      = this.targets
    var activeTarget = this.activeTarget
    var i
    if (this.scrollHeight != scrollHeight) {
      this.refresh()
    }
    //如果超过了最大滚动,说明已经滚动到底了
    if (scrollTop >= maxScroll) {
      //如果最后一个元素还没有高亮,则设置最后一个元素高亮
      return activeTarget != (i = targets[targets.length - 1]) && this.activate(i)
    }

    if (activeTarget && scrollTop < offsets[0]) {
      this.activeTarget = null
      return this.clear()
    }
    //倒序遍历所有元素的offset
    for (i = offsets.length; i--;) {
      //如果i元素不等于当前高亮元素
      activeTarget != targets[i]
        //滚动高度 大于 i元素的offsets
        && scrollTop >= offsets[i]
        //i+1元素不存在,或者i+1元素大于滚动高度
        && (offsets[i + 1] === undefined || scrollTop < offsets[i + 1])
        //则设置i为高亮元素
        && this.activate(targets[i])
    }
  }

  //设置高亮菜单元素
  ScrollSpy.prototype.activate = function (target) {
    //赋值实例属性
    this.activeTarget = target

    this.clear()
    //查找菜单中符合[data-target+"#' + 所高亮元素的id + '"]属性的元素
    //或者href值是#' +  所高亮元素的id + '的话,也可以
    var selector = this.selector +
      '[data-target="' + target + '"],' +
      this.selector + '[href="' + target + '"]'
    //查找父元素li,然后添加active高亮样式
    var active = $(selector)
      .parents('li')
      .addClass('active')
    //如果li元素的父元素有dropdown-menu样式,则表示是一个dropdown下拉菜单
    if (active.parent('.dropdown-menu').length) {
      active = active
        .closest('li.dropdown')
        //则需要给dropdown的li元素也加上active高亮样式
        .addClass('active')
    }
    //触发自定义高亮事件
    active.trigger('activate.bs.scrollspy')
  }

  //删除其他高亮元素的active样式
  ScrollSpy.prototype.clear = function () {
    $(this.selector)
      .parentsUntil(this.options.target, '.active')
      .removeClass('active')
  }

【四】jQuery插件定义

  function Plugin(option) {
    //根据选择器,遍历所有符合规则的元素
    return this.each(function () {
      var $this   = $(this)
      //获取自定义属性bs.scrollspy的值
      var data    = $this.data('bs.scrollspy')
      //如果option参数是对象,则作为ScrollSpy的参数传入
      var options = typeof option == 'object' && option
      //如果值不存在,则将ScrollSpy实例设置为bs.scrollSpy值
      if (!data) $this.data('bs.scrollspy', (data = new ScrollSpy(this, options)))
      //如果option传递了string,则表示要执行某个方法
      if (typeof option == 'string') data[option]()
    })
  }

  var old = $.fn.scrollspy
  //保留其他库的$.fn.scrollspy代码(如果定义的话),以便在noConflict之后可以继续使用该老代码
  $.fn.scrollspy             = Plugin
  //重设插件构造器,可以通过该属性获取插件的真实类函数
  $.fn.scrollspy.Constructor = ScrollSpy

【5】防争执处理

  $.fn.scrollspy.noConflict = function () {
     //恢复以前的旧代码
    $.fn.scrollspy = old
    //将$.fn.scrollspy.noConflict()设置为Bootstrap的Scrollspy插件
    return this
  }

【陆】绑定触发事件

  $(window).on('load.bs.scrollspy.data-api', function () {
    //遍历所有符合条件的滚动容器
    $('[data-spy="scroll"]').each(function () {
      var $spy = $(this)
      //执行scrollspy插件,并传入滚动容器上设置的自定义参数(data-开头)
      Plugin.call($spy, $spy.data())
    })
  })

 

相关文章

网站地图xml地图