Giter Club home page Giter Club logo

vue-smooth-infinite-scroll's Introduction

vue-smooth-infinite-scroll

Version Documentation Maintenance License: MIT

vue2

A high-performance Vue.js plugin with virtual DOM list to support fast, smooth infinite scroll

Demo GIF

Install

npm install --save vue-smooth-infinite-scroll

OR 

yearn add vue-smooth-infinite-scroll

Import into your project

// in a vue2 project
import SmoothInfiniteScroll from "vue-smooth-infinite-scroll";

// common JS
var SmoothInfiniteScroll = require("vue-smooth-infinite-scroll");

Usage

<template>
    <smooth-infinite-scroll
        :itemHeight="220"
        :items="items"
        @next="onNext"
        :hasMore="hasMore"
        :preRenderCount="3"
    >
        <template v-slot="{ item }">
            <div>
                {{ item }}
            </div>
        </template>

        <template #loader>
            <span>Your custom loader component</span>
        </template>

        <template #noMoreData>
            <span>Your custom "no more data" component</span>
        </template>
    </smooth-infinite-scroll>
</template>

<script>
import SmoothInfiniteScroll from "vue-smooth-infinite-scroll";

export default {
    components: {
        SmoothInfiniteScroll
    },

    data() {
        return {
            items: [],
            currPage: 1,
            hasMore: true
        }
    },

    methods: {
        async fetchNewData(page) {
            /* your code to fetch new data by page number */
            const newData = await this.$http.get("SOME_URL");
            if (!newData.length) {
                // set hasMore to false for "noMoreData" slot to render
                this.hasMore = false;
            } else {
                // pass new data into the infinite scroll component
                this.items = this.items.concat(newData);
            }
        },

        onNext() {
            // fetch the next page of data upon hitting the bottom
            this.currPage = this.currPage + 1;
            this.fetchNewData(this.currPage);
        }
    }
}
</script>

Props, Slots and Events

Props

name type description
itemHeight Number Required Height for each item in the infinite scroll in pixels
hasMore Boolean Required If true, the infinite scroll will emit next event when hitting the bottom of the scroll. Otherwise, it will display the custom or default "no more data" component at the bottom of the scroll
items Array Required The list data items which you need to scroll
preRenderCount Number Optional Number of items to be preemptively rendered before they enter the viewport. A higher number will give a smoother scroll but renders more DOM elements. Default is 5
scrollableTargetId String Optional ID of the parent element to which the scrolling action is relative. Only required when scrolling inside of a element with a fixed height

Slots

name description default
loader Shown when new data is being fetched <span>Loading...</span>
noMoreData Shown where user has reached the bottom of the scroll (i.e. when no new data is available) <span>No more data</span>

Events

name description handling
next Emitted from the SmoothInfiniteScroll component whenever user has reached the bottom of the scroll Your own onNext function which will request new data, concatenate it with this.items and set hasMore accordingly as in the above example

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

License

Copyright © 2022 hao.
This project is MIT licensed.


This README was generated with ❤️ by readme-md-generator

vue-smooth-infinite-scroll's People

Contributors

haotian9850 avatar

Stargazers

X avatar  avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.