1---
2category: Sensors
3---
4 
5# useInfiniteScroll
6 
7Infinite scrolling of the element.
8 
9## Usage
10 
11```vue
12<script setup lang="ts">
13import { useInfiniteScroll } from '@vueuse/core'
14import { ref, useTemplateRef } from 'vue'
15 
16const el = useTemplateRef('el')
17const data = ref([1, 2, 3, 4, 5, 6])
18 
19const { reset } = useInfiniteScroll(
20  el,
21  () => {
22    // load more
23    data.value.push(...moreData)
24  },
25  {
26    distance: 10,
27    canLoadMore: () => {
28      // inidicate when there is no more content to load so onLoadMore stops triggering
29      // if (noMoreContent) return false
30      return true // for demo purposes
31    },
32  }
33)
34 
35function resetList() {
36  data.value = []
37  reset()
38}
39</script>
40 
41<template>
42  <div ref="el">
43    <div v-for="item in data">
44      {{ item }}
45    </div>
46  </div>
47  <button @click="resetList()">
48    Reset
49  </button>
50</template>
51```
52 
53## Direction
54 
55Different scroll directions require different CSS style settings:
56 
57| Direction          | Required CSS                                          |
58| ------------------ | ----------------------------------------------------- |
59| `bottom` (default) | No special settings required                          |
60| `top`              | `display: flex;`<br>`flex-direction: column-reverse;` |
61| `left`             | `display: flex;`<br>`flex-direction: row-reverse;`    |
62| `right`            | `display: flex;`                                      |
63 
64::: warning
65Make sure to indicate when there is no more content to load with `canLoadMore`, otherwise `onLoadMore` will trigger as long as there is space for more content.
66:::
67 
68## Directive Usage
69 
70```vue
71<script setup lang="ts">
72import { vInfiniteScroll } from '@vueuse/components'
73import { ref } from 'vue'
74 
75const data = ref([1, 2, 3, 4, 5, 6])
76 
77function onLoadMore() {
78  const length = data.value.length + 1
79  data.value.push(...Array.from({ length: 5 }, (_, i) => length + i))
80}
81function canLoadMore() {
82  // inidicate when there is no more content to load so onLoadMore stops triggering
83  // if (noMoreContent) return false
84  return true // for demo purposes
85}
86</script>
87 
88<template>
89  <div v-infinite-scroll="onLoadMore">
90    <div v-for="item in data" :key="item">
91      {{ item }}
92    </div>
93  </div>
94 
95  <!-- with options -->
96  <div v-infinite-scroll="[onLoadMore, { distance: 10, canLoadMore }]">
97    <div v-for="item in data" :key="item">
98      {{ item }}
99    </div>
100  </div>
101</template>
102```
103 
104## Type Declarations
105 
106```ts
107type InfiniteScrollElement =
108  | HTMLElement
109  | SVGElement
110  | Window
111  | Document
112  | null
113  | undefined
114export interface UseInfiniteScrollOptions<
115  T extends InfiniteScrollElement = InfiniteScrollElement,
116> extends UseScrollOptions {
117  /**
118   * The minimum distance between the bottom of the element and the bottom of the viewport
119   *
120   * @default 0
121   */
122  distance?: number
123  /**
124   * The direction in which to listen the scroll.
125   *
126   * @default 'bottom'
127   */
128  direction?: "top" | "bottom" | "left" | "right"
129  /**
130   * The interval time between two load more (to avoid too many invokes).
131   *
132   * @default 100
133   */
134  interval?: number
135  /**
136   * A function that determines whether more content can be loaded for a specific element.
137   * Should return `true` if loading more content is allowed for the given element,
138   * and `false` otherwise.
139   */
140  canLoadMore?: (el: T) => boolean
141}
142export interface UseInfiniteScrollReturn {
143  isLoading: ComputedRef<boolean>
144  reset: () => void
145}
146/**
147 * Reactive infinite scroll.
148 *
149 * @see https://vueuse.org/useInfiniteScroll
150 */
151export declare function useInfiniteScroll<T extends InfiniteScrollElement>(
152  element: MaybeRefOrGetter<T>,
153  onLoadMore: (state: UnwrapNestedRefs<UseScrollReturn>) => Awaitable<void>,
154  options?: UseInfiniteScrollOptions<T>,
155): UseInfiniteScrollReturn
156```
157