Interface VirtualScrollProps

Props accepted by VirtualScroll

interface VirtualScrollProps {
    children: VirtualContentRender;
    className?: string;
    height: number;
    innerClassName?: string;
    innerRender?: VirtualContainerRender;
    maxCssSize?: number;
    minNumPages?: number;
    onScroll?: ((verticalOffset: number, horizontalOffset: number, newVerticalScrollState: ScrollState, newHorizontalScrollState: ScrollState) => void);
    outerRender?: VirtualContainerRender;
    scrollHeight?: number;
    scrollWidth?: number;
    useIsScrolling?: boolean;
    useOffsets?: boolean;
    width: number;
}

Hierarchy (view full)

Properties

children className? height innerClassName? innerRender? maxCssSize? minNumPages? onScroll? outerRender? scrollHeight? scrollWidth? useIsScrolling? useOffsets? width

Properties

children

children: VirtualContentRender

Function implementing VirtualContentRender that renders the content that needs to respond to scrolling

OptionalclassName

className?: string

The className applied to the outer container element. Use when styling the entire component.

height

height: number

Component height

OptionalinnerClassName

innerClassName?: string

The className applied to the inner container element. Use for special cases when styling only the inner container and items.

OptionalinnerRender

innerRender?: VirtualContainerRender

Render prop implementing VirtualContainerRender. Used to customize VirtualScroll inner container.

OptionalmaxCssSize

maxCssSize?: number

Maximum size for CSS element beyond which layout breaks. You should never normally need to change this. The default value is compatible with all major browsers.

Default Value

6000000

OptionalminNumPages

minNumPages?: number

The minimum number of virtual pages to use when inner container would otherwise be more than VirtualScrollableProps.maxCssSize big. You should never normally need to change this.

Default Value

100

OptionalonScroll

onScroll?: ((verticalOffset: number, horizontalOffset: number, newVerticalScrollState: ScrollState, newHorizontalScrollState: ScrollState) => void)

Callback after a scroll event has been processed and state updated but before rendering

Type declaration

    • (verticalOffset, horizontalOffset, newVerticalScrollState, newHorizontalScrollState): void

    • Parameters

      • verticalOffset: number

        Resulting overall vertical offset.

      • horizontalOffset: number

        Resulting overall horizontal offset.

      • newVerticalScrollState: ScrollState

        New vertical ScrollState that will be used for rendering.

      • newHorizontalScrollState: ScrollState

        New horizontal ScrollState that will be used for rendering.

      Returns void

OptionalouterRender

outerRender?: VirtualContainerRender

Render prop implementing VirtualContainerRender. Used to customize VirtualScroll outer container.

OptionalscrollHeight

scrollHeight?: number

Height of area to scroll over

Default Value

0

OptionalscrollWidth

scrollWidth?: number

Width of area to scroll over

Default Value

0

OptionaluseIsScrolling

useIsScrolling?: boolean

Determines whether the component should track whether it's being actively scrolled and pass through when rendering its content.

Default Value

false

OptionaluseOffsets

useOffsets?: boolean

Determines whether the component should pass verticalOffset and horizontalOffset to children when rendering.

Can reduce the number of renders needed if these props aren't used

Default Value

true

width

width: number

Component width

Settings

Member Visibility

On This Page

Properties