参数

说明

类型

默认值

data-key

The unique key get from data-sources in each data object. Or a function called with each data-source and return their unique key. Its value must be unique in data-sources, it is used for identifying item size.

string | () => string

-

data-sources

The source array built for list, each array data must be an object and has an unique key get or generate for data-key property.

object[]

-

data-component

The render item component created / declared by vue, and it will use the data object in data-sources as render prop and named: source.

Component

-

参数

说明

类型

默认值

keeps

How many items you are expecting the virtual list to keep rendering in the real dom

number

30

extra-props

Extra props assign to item component that are not in data-sources. Notice: index and source are both occupied inner

Object

{}

estimate-size

The estimate size of each item, if it is closer to the average size, the scrollbar length looks more accurately. It is recommended to assign the average that calculate by yourself

number

50

方法名

说明

回调参数

reset

Reset all state back to initial

-

scrollToBottom

Manual set scroll position to bottom

-

scrollToIndex

Manual set scroll position to a designated index

index: number

scrollToOffset

Manual set scroll position to a designated offset

offset: number

getSize

Get the designated item size by id (from data-key value)

id: string

getSizes

Get the total number of stored (rendered) items

-

getOffset

Get current scroll offset.

-

getClientSize

Get wrapper element client viewport size (width or height)

-

getScrollSize

Get all scroll size (scrollHeight or scrollWidth)

-

updatePageModeFront

When using page mode and virtual list root element offsetTop or offsetLeft change, you need call this method manually

-

名称

说明

header

header slot

footer

footer slot