@tygr/vue-infinite-scroll

Infinite scroll component for VueJS
1,342 1
Install
npm install @tygr/vue-infinite-scroll
Latest Version:1.2.0
Vue:2
License:MIT
Last Updated:Feb 20, 2019
Links: GitHub  ·  npm
Maintainer: jg83

Vue Infinite Scroll

Demo

Installation

Node

npm i --save @tygr/vue-infinite-scroll

Register the component:

import InfiniteScroll from '@tygr/vue-infinite-scroll';

export default {
  components: {
    'infinite-scroll': InfiniteScroll
  }
}

Browser

<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
<script src="https://unpkg.com/@tygr/vue-infinite-scroll/dist/vue-infinite-scroll.min.js"></script>
<script>
  // Register the plugin globally
  Vue.use(InfiniteScroll.default)
</script>

Usage

By default it will have 'overflow: scroll' and 'display: flex' in the correct directions based on the 'direction' prop

For vertical scrolling (direction = 'down' | 'up'), a specified height is necessary. By default it is 200 px.

<template>
  <infinite-scroll @load-more="loadMore">
    <div v-for="i in numElements">Element {{ i }}</div>
  </infinite-scroll>
</template>

<script>
  export default {
    data: {
      numElements: 50
    },
    methods: {
      loadMore() {
        numElements += 50;
      }
    }
  }
</script>

Events

event payload description
load-more null Emitted whenever the user has reached the end of scrollable content

Props

prop type default description
direction String down The direction to scroll in order to load more items. Either 'down', 'up', 'left', or 'right'
minDistance Number 10 The buffer distance to triger the 'load-more' event in pixels. Increase this if the event is not triggering
throttleTime Number 1000 The minimum amount of time between triggers of the 'load-more' event in milliseconds. Uses rxjs' 'throttleTime' operator
repeat boolean false Whether to keep calling 'load-more' after reaching bottom even if user has not scrolled further

Related Packages

@jfm/vue-infinite-scroll

A bidirectional infinite scroll component for Vue.js

1,565 2
vue-infinite-iscroll

A vue infinite scroll

1,037 4
@damisgarcia/v-infinite-scroll

`v-infinite-scroll` is a Vue 3 directive based on the Intersection Observer API....

1,238 0
vue-quick-loadmore

基于vue的移动端下拉刷新上拉无限滚动加载支持自定义文案自定义gif图的插件

919 132
vue-mugen-scroll

Infinite scroll component for Vue.js

130,014 529

Version History

Version Released Vue License
1.2.0 2 MIT
1.1.7 2 MIT
1.1.6 ~2.5.20 MIT
1.1.5 ~2.5.20 MIT
1.1.4 ~2.5.20 MIT