element-plus/website/docs/en-US/infiniteScroll.md
qiang 87a16f24d3
workflow: Auto generate code hint files from the docs (#1749)
* chore: add components-helper

* docs: unified style

* docs: unified style

* docs: unified style

* docs: unified style

* chore: replace Accepted Values for icon

* chore: delete vetur folder

* chore: add components-helper

* docs: unified style

* docs: unified style

* docs: unified style

* docs: unified style

* chore: replace Accepted Values for icon

* chore: delete vetur folder
2021-04-06 11:41:02 +08:00

2.0 KiB

InfiniteScroll

Load more data while reach bottom of the page

Basic usage

Add v-infinite-scroll to the list to automatically execute loading method when scrolling to the bottom. :::demo

<template>
  <ul class="infinite-list" v-infinite-scroll="load" style="overflow:auto">
    <li v-for="i in count" class="infinite-list-item">{{ i }}</li>
  </ul>
</template>

<script>
  export default {
    data () {
      return {
        count: 0
      }
    },
    methods: {
      load () {
        this.count += 2
      }
    }
  }
</script>

:::

Disable Loading

:::demo

<template>
  <div class="infinite-list-wrapper" style="overflow:auto">
    <ul
      class="list"
      v-infinite-scroll="load"
      infinite-scroll-disabled="disabled">
      <li v-for="i in count" class="list-item">{{ i }}</li>
    </ul>
    <p v-if="loading">Loading...</p>
    <p v-if="noMore">No more</p>
  </div>
</template>

<script>
  export default {
    data () {
      return {
        count: 10,
        loading: false
      }
    },
    computed: {
      noMore () {
        return this.count >= 20
      },
      disabled () {
        return this.loading || this.noMore
      }
    },
    methods: {
      load () {
        this.loading = true
        setTimeout(() => {
          this.count += 2
          this.loading = false
        }, 2000)
      }
    }
  }
</script>

:::

Directives

Name Description Type Accepted values Default
v-infinite-scroll Load more data while reach bottom of the page function - -
infinite-scroll-disabled is disabled boolean - false
infinite-scroll-delay throttle delay (ms) number - 200
infinite-scroll-distance trigger distance (px) number - 0
infinite-scroll-immediate Whether to execute the loading method immediately, in case the content cannot be filled up in the initial state. boolean - true