实现一个简单的 vue 无限加载指令

vue 中的自定义指令是对底层 dom 进行操作,下面以实现滚动到底部加载数据,实现无限加载来介绍如何自定义一个简单的指令。

无限加载的原理是通过对滚动事件的监听,每一次滚动都要获取到已滚动的距离,如果滚动的距离加上浏览器窗口高度,会大于等于内容高度,就触发函数加载数据。

先介绍不使用 vue 的情况如何实现无限加载。

不使用框架

首先是html:

<!DOCTYPE html><html lang="en">
<head><meta charset="UTF-8">
<title>实现滚动加载</title>
<style>
  * {
    -webkit-box-sizing: border-box;
    -moz-box-sizing: border-box;
    box-sizing: border-box;
   }
  li, ul {
    list-style: none;
  }
  .container {
    width: 980px;
    margin: 0 auto;
  }
  .news__item {
    height: 80px;
    margin-bottom: 20px;
    border: 1px solid #eee;
  }</style>
</head>
<body>
<div class="container">
  <ul class="news" id="news">
    <li class="news__item">1、hello world</li>
    <li class="news__item">2、hello world</li>
    <li class="news__item">3、hello world</li>
    <li class="news__item">4、hello world</li>
    <li class="news__item">5、hello world</li>
    <li class="news__item">6、hello world</li>
    <li class="news__item">7、hello world</li>
    <li class="news__item">8、hello world</li>
    <li class="news__item">9、hello world</li>
    <li class="news__item">10、hello world</li>
  </ul>
</div>
</body>
</html>

打开浏览器,调整下浏览器窗口高度,让页面可以滚动。
先了解三个变量

  • document.body.scrollTop 滚动条滚动的距离
  • window.innerHeight 浏览器窗口高度
  • document.body.clientHeight 内容高度

对应上面的原理就是

window.addEventListener('scroll', function() {
  var scrollTop = document.body.scrollTop;
  if(scrollTop + window.innerHeight >= document.body.clientHeight) {
    // 触发加载数据        
    loadMore();
  }
});
function loadMore() {
  console.log('加载数据')
}

loadMore() 函数就是从接口获取到数据,组装 html,插入到原先到节点后面。

// 表示列表的序号
var index = 10;
function loadMore() {
  var content = '';
  for(var i=0; i< 10; i++) {
    content += '<li class="news__item">'+(++index)+'、hello world</li>'    
  }
  var node = document.getElementById('news');
  // 向节点内插入新生成的数据    
  var oldContent =     node.innerHTML;
  node.innerHTML = oldContent+content;
}

这样就实现了无限加载。

2017/04/15 新增

用图片说说明大概是这样的:

示意图

可以看到和滚动相关的有两个盒子,windowdocument.bodydocument.body是放在window中的,并且window是有一个固定高度。

如果不是全屏而是页面上某一个元素需要实现无限滚动,其实原理是一样的,必须有两个盒子,这里命名为wrappercontainerwrapper就是对应上面的window,而container对应document.body

同样使用上面的代码:

<div class="container">
  <ul class="news" id="news">
    <li class="news__item">1、hello world</li>
    <li class="news__item">2、hello world</li>
    <li class="news__item">3、hello world</li>
    <li class="news__item">4、hello world</li>
    <li class="news__item">5、hello world</li>
    <li class="news__item">6、hello world</li>
    <li class="news__item">7、hello world</li>
    <li class="news__item">8、hello world</li>
    <li class="news__item">9、hello world</li>
    <li class="news__item">10、hello world</li>
  </ul>
</div>

这里的.container盒子就是我们需要的wrapper,而.news盒子就是container,先获取到两个节点,直接替代之前的windowdocument.body

    var wrapper = document.querySelector('.container')
    var container = document.querySelector('.news')
    wrapper.addEventListener('scroll', function() {
        var scrollTop = container.scrollTop;
        if (scrollTop + wrapper.innerHeight >= container.clientHeight) {
            // 触发加载数据        
            loadMore();
        }
    });
    // 表示列表的序号
    var index = 10;

    function loadMore() {
        var content = '';
        for (var i = 0; i < 10; i++) {
            content += '<li class="news__item">' + (++index) + '、hello world</li>'
        }
        var node = document.getElementById('news');
        // 向节点内插入新生成的数据    
        var oldContent = node.innerHTML;
        node.innerHTML = oldContent + content;
    }

仅仅是做了替换,其他代码都没有做修改。但是打开网页发现并没有实现我们需要的效果,因为此时的滚动条是属于window的,我们需要让wrapper出现滚动条,所以需要给wrapper高度并且设置overflow: auto;

OK,出现滚动条了,滚动到底部并没有触发加载数据,打印scrollTop发现一直都是 0,其实是要获取到wrapper的滚动的距离而不是container的。

var scrollTop = wrapper.scrollTop;

此时再次滚动可以发现打印出了正确的值但是仍然没有触发加载数据,因为wrapper.innerHeightundefined改为wrapper.clientHeight就可以了。

实际代码

在 vue 中使用指令实现

为什么要用指令实现呢?好像只有指令是可以获取到底层 dom 的?而实现无限加载,是需要拿到内容高度的。

首先初始化一个项目,添加一个组件,用来显示列表。

// components/Index.vue
<template>
  <div>
    <ul class="news">
      <li class="news__item" v-for="(news, index) in newslist">
        {{index}}-{{news.title}}
      </li>
    </ul>
  </div>
</template>
<style>
  .news__item {
    height: 80px;
    border: 1px solid #ccc;
    margin-bottom: 20px;
  }
</style>
<script>
  export default{
    data(){
      return{
        newslist: [
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'},
          {title: 'hello world'}
        ]
      }
    }
  }
</script>

OK,现在开始编写指令。从传统实现中,我们了解到要注册对滚动事件对监听,同时拿到内容高度。

//
directives: {
  scroll: {
    bind: function (el, binding){
      window.addEventListener('scroll', ()=> {
        if(document.body.scrollTop + window.innerHeight >= el.clientHeight) {
          console.log('load data');
        }
      })
    }
  }
}

首先是在组件内注册了 scroll 指令,然后在指令第一次绑定到组件时,也就是对应着 bind钩子,注册滚动监听。

钩子函数就是一些生命周期改变时会调用的函数。bind 在第一次绑定到组件时调用、unbind 在指令与组件解绑时调用。

还可以注意到 bind 对应到函数有两个参数,el 和 binding,这是钩子函数参数,比如 el 对应绑定的节点,binding 有很多数据,比如传给指令的参数等。

下面的el.clientHeight就是表示获取绑定指令的这个节点的内容高度。

和之前一样,判断滚动的高度加上窗口高度是否大于内容高度。

绑定指令到节点上:

<template>
  <div v-scroll="loadMore">
    <ul class="news">
      <li class="news__item" v-for="(news, index) in newslist">
        {{index}}-{{news.title}}
      </li>
    </ul>
  </div>
</template>

可以看到给指令传了一个值,这个值就是加载数据的函数:

methods: {
  loadMore() {
    let newAry = [];
    for(let i = 0; i < 10; i++) {
      newAry.push({title: 'hello world'})
    }
    this.newslist = [...this.newslist, ...newAry];
  }
}

当然,现在在滚动到底部时,只会打印load data,只要把这里改成调用函数就OK了:

 window.addEventListener('scroll', ()=> { 
  if(document.body.scrollTop + window.innerHeight >= el.clientHeight) {   
    let fnc = binding.value;   
    fnc(); 
  }
})

v-scroll="loadMore"loadMore可以在钩子函数参数的 binding 上拿到。

至此,一个简单的指令就完成了。

优化

上面的例子并没有真正从接口获取数据,所以存在一个隐藏的 bug:当接口响应很慢的情况,滚动到底部正在加载数据时,稍微滚动一下仍会触发获取数据函数,这会造成同时请求多次接口,一次性返回大量数据。

解决办法是添加一个全局变量 scrollDisable,当第一次触发加载数据函数时,将该值设置为 true,根据该值判断是否要执行加载函数。

以普通实现为例:

var scrollDisable = false;
window.addEventListener('scroll', function() {
  var scrollTop = document.body.scrollTop;
  if(scrollTop + window.innerHeight >= document.body.clientHeight) {
    // 触发加载数据        
    if(!scrollDisable) {
      // 
      loadMore();  
    }  
  }
});
// 表示列表的序号
var index = 10;
function loadMore() {
   // 开始加载数据,就不能再次触发这个函数了
  scrollDisable = true;
  var content = '';
  for(var i=0; i< 10; i++) {
    content += '<li class="news__item">'+(++index)+'、hello world</li>'    
  }
  var node = document.getElementById('news');
  // 向节点内插入新生成的数据    
  var oldContent =     node.innerHTML;
  node.innerHTML = oldContent+content;
  // 插入数据完成后   
  scrollDisable = false;
}

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,945评论 4 60
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,057评论 25 707
  • 心里有人那叫有追求 心里没人那叫自在 心里有放下的人叫看透 心里有放不下的人那叫执着。一生很短,追求很多,无法完美...
    末离一阅读 163评论 0 0