Interface: VirtualizerProps\

September 22, 2026 · View on GitHub

API

Interface: VirtualizerProps<T>

Defined in: src/vue/Virtualizer.tsx:38

Props of Virtualizer.

Properties

data

data: T[]

Defined in: src/vue/Virtualizer.tsx:42

The data items rendered by this component.

bufferSize?

optional bufferSize?: number

Defined in: src/vue/Virtualizer.tsx:47

Extra item space in pixels to render before/after the viewport. The minimum value is 0. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling.

itemSize?

optional itemSize?: number

Defined in: src/vue/Virtualizer.tsx:54

Item size hint for unmeasured items in pixels. It will help to reduce scroll jump when items are measured if used properly.

If not set, initial item sizes will be automatically estimated from measured sizes. This is recommended for most cases.
If set, you can opt out estimation and use the value as initial item size.

shift?

optional shift?: boolean

Defined in: src/vue/Virtualizer.tsx:58

While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling.

horizontal?

optional horizontal?: boolean

Defined in: src/vue/Virtualizer.tsx:62

If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list.

startMargin?

optional startMargin?: number

Defined in: src/vue/Virtualizer.tsx:66

The offset to the scrollable parent before virtualizer in pixels. If you put an element before virtualizer, you have to set its height to this prop.

ssrCount?

optional ssrCount?: number

Defined in: src/vue/Virtualizer.tsx:70

A prop for SSR. If set, the specified amount of items will be mounted in the initial rendering regardless of the container size until hydrated. The minimum value is 0.

scrollRef?

optional scrollRef?: HTMLElement

Defined in: src/vue/Virtualizer.tsx:74

Reference to the scrollable element. The default will get the direct parent element of virtualizer.

as?

optional as?: keyof IntrinsicElementAttributes

Defined in: src/vue/Virtualizer.tsx:79

Component or element type for container element.

Default Value

"div"

item?

optional item?: keyof IntrinsicElementAttributes

Defined in: src/vue/Virtualizer.tsx:84

Component or element type for item element.

Default Value

"div"

itemProps?

optional itemProps?: ItemProps<T>

Defined in: src/vue/Virtualizer.tsx:90

A function that provides properties/attributes for item element

This prop will be merged into item prop in the future

keepMounted?

optional keepMounted?: readonly number[]

Defined in: src/vue/Virtualizer.tsx:94

List of indexes that should be always mounted, even when off screen.

cache?

optional cache?: CacheSnapshot

Defined in: src/vue/Virtualizer.tsx:100

You can restore cache by passing a CacheSnapshot on mount. This is useful when you want to restore scroll position after navigation. The snapshot can be obtained from VirtualizerHandle.cache.

The length of items should be the same as when you take the snapshot, otherwise restoration may not work as expected.

onScroll?

optional onScroll?: (offset) => void

Defined in: src/vue/Virtualizer.tsx:105

Callback invoked whenever scroll offset changes.

optional onScrollEnd?: () => void

Defined in: src/vue/Virtualizer.tsx:109

Callback invoked when scrolling stops.

Returns

void

key?

optional key?: PropertyKey

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1215

Inherited from

PublicProps.key

ref?

optional ref?: VNodeRef

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1216

Inherited from

PublicProps.ref

ref_for?

optional ref_for?: boolean

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1217

Inherited from

PublicProps.ref_for

ref_key?

optional ref_key?: string

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1218

Inherited from

PublicProps.ref_key

onVnodeBeforeMount?

optional onVnodeBeforeMount?: VNodeMountHook | VNodeMountHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1219

Inherited from

PublicProps.onVnodeBeforeMount

onVnodeMounted?

optional onVnodeMounted?: VNodeMountHook | VNodeMountHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1220

Inherited from

PublicProps.onVnodeMounted

onVnodeBeforeUpdate?

optional onVnodeBeforeUpdate?: VNodeUpdateHook | VNodeUpdateHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1221

Inherited from

PublicProps.onVnodeBeforeUpdate

onVnodeUpdated?

optional onVnodeUpdated?: VNodeUpdateHook | VNodeUpdateHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1222

Inherited from

PublicProps.onVnodeUpdated

onVnodeBeforeUnmount?

optional onVnodeBeforeUnmount?: VNodeMountHook | VNodeMountHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1223

Inherited from

PublicProps.onVnodeBeforeUnmount

onVnodeUnmounted?

optional onVnodeUnmounted?: VNodeMountHook | VNodeMountHook[]

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1224

Inherited from

PublicProps.onVnodeUnmounted

class?

optional class?: unknown

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1403

Inherited from

PublicProps.class

style?

optional style?: unknown

Defined in: node_modules/@vue/runtime-core/dist/runtime-core.d.ts:1404