Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement
Sign In

vue-virtual-list-observer

Package Overview
Dependencies
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vue-virtual-list-observer

keyword: **intersectionObserver scroll-list Scroll animation,quick scroll resolved**

latest
Source
npmnpm
Version
0.1.2
Version published
Weekly downloads
1.4K
-18.91%
Maintainers
1
Weekly downloads
 
Created
Source

vue-virtual-list-observer

keyword: intersectionObserver scroll-list Scroll animation,quick scroll resolved

yarn add vue-virtual-list-observer

Downloads Version Quality

Advantages

  • Only 3 required props, simple and very easy to use.

  • intersectionObserver efficient and resolve Fast scrolling in a white screen.

  • Highly customizable and has a live demo to get started quickly

  • Callback function, which allows the dynamic addition of list items according to the scrolling situation

import { ListDOM } from 'vue-virtual-list-observer'

live demo1

stackblitz

newest demo checked by git clone and yarn && yarn dev

npm install vue-virtual-list-observer 

or

yarn add vue-virtual-list-observer

Props type

Required props

             Prop             TypeDescription
visualDomCountNumberNumber of elements visible in the list.It is worth noting that the number of render Doms is usually greater than the number of visualDoms
resArrArray[]The source array built for list, The effect and logic are the same as the real list
scrollInstancefunction(){return HTMLDivElement }Need to transfer the nearest scrollable ancestor of the ListDOM component (for custom scroll bar and else)

Option props

PropTypeDescription
domHeightNumberApproximate height of list item, usually used to handle edge cases
scrollAnimaBooleanscrollToTop has a scrolling effect,not directly

Public methods (provide,emit)

MethodDescription
requestEvent triggered when the scroll bar scrolls to the bottom and the number of elements in resArr is not enough for the next loading, this event will be triggered. (Typically, that function need you to request api and pushes new data into resarr)

public methods(ref)

MethodDescription
getScrollGet the scrollTop distance of the list
scrollToTopset scroll position to ListTop.
scrollToIndexset scroll position to resArr[index]

slot

MethodDescription
listSet the style of the list item element
footerSet the style of loading to request

Attention

for the public method(provide,emit) request

if you want to do some async things, in the provide function you need return promise instance,because of async func is uncontrollable for the ListDOM Childcomponent. And you need to use provide api to provide request function to ListDOM component

async why can't use emit

$emit() just triggers the event, after the event is triggered, the logic task of the (child) component ends

So async need to use provide && return promise instance

not async

In the request function you usually request the backend's interface and display it on the screen

If not as mentioned above, no limit

License

MIT License.

Keywords

vue3

FAQs

Package last updated on 02 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts