Skip to content

WindowVirtualizerProps.md

Latest commit

 

History

History
168 lines (88 loc) · 5.28 KB

WindowVirtualizerProps.md

File metadata and controls

168 lines (88 loc) · 5.28 KB

API

Interface: WindowVirtualizerProps<T>

Defined in: src/react/WindowVirtualizer.tsx:58

Props of WindowVirtualizer.

Type Parameters

T

T = unknown

Properties

children

children: ReactNode | (data, index) => ReactElement

Defined in: src/react/WindowVirtualizer.tsx:64

Elements rendered by this component.

You can also pass a function and set WindowVirtualizerProps.data to create elements lazily.

data?

optional data: ArrayLike<T>

Defined in: src/react/WindowVirtualizer.tsx:68

The data items rendered by this component. If you set a function to WindowVirtualizerProps.children, you have to set this prop.

overscan?

optional overscan: number

Defined in: src/react/WindowVirtualizer.tsx:73

Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling.

Default Value

4

itemSize?

optional itemSize: number

Defined in: src/react/WindowVirtualizer.tsx:80

Item size hint for unmeasured items. 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/react/WindowVirtualizer.tsx:84

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/react/WindowVirtualizer.tsx:88

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

cache?

optional cache: CacheSnapshot

Defined in: src/react/WindowVirtualizer.tsx:94

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 WindowVirtualizerHandle.cache.

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

ssrCount?

optional ssrCount: number

Defined in: src/react/WindowVirtualizer.tsx:98

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.

as?

optional as: CustomContainerComponent | keyof IntrinsicElements

Defined in: src/react/WindowVirtualizer.tsx:103

Component or element type for container element.

Default Value

"div"

item?

optional item: CustomItemComponent | keyof IntrinsicElements

Defined in: src/react/WindowVirtualizer.tsx:108

Component or element type for item element. This component will get CustomItemComponentProps as props.

Default Value

"div"

onScroll()?

optional onScroll: () => void

Defined in: src/react/WindowVirtualizer.tsx:112

Callback invoked whenever scroll offset changes.

Returns

void

onScrollEnd()?

optional onScrollEnd: () => void

Defined in: src/react/WindowVirtualizer.tsx:116

Callback invoked when scrolling stops.

Returns

void