The Candid Startup
    Preparing search index...

    Props accepted by VirtualList

    interface VirtualListProps {
        children: DisplayListItem;
        className?: string;
        height: number;
        innerClassName?: string;
        innerRender?: VirtualContainerRender;
        itemCount: number;
        itemData?: unknown;
        itemKey?: ListItemKey;
        itemOffsetMapping: ItemOffsetMapping;
        layout?: ScrollLayout;
        maxCssSize?: number;
        minNumPages?: number;
        onScroll?: VirtualListScrollHandler;
        outerRender?: VirtualContainerRender;
        useIsScrolling?: boolean;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children: DisplayListItem

    Component used as a template to render items in the list. Must implement DisplayListItem interface.

    className?: string

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

    height: number

    Component height

    innerClassName?: string

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

    Render prop implementing VirtualContainerRender. Used to customize DisplayList within VirtualList inner container.

    itemCount: number

    Number of items in the list

    itemData?: unknown

    Passed as DisplayBaseItemProps.data to each child item

    itemKey?: ListItemKey

    Function implementing ListItemKey that defines the key to use for each item.

    (index, _data) => index

    itemOffsetMapping: ItemOffsetMapping

    Implementation of ItemOffsetMapping interface that defines size and offset to each item in the list

    Use useFixedSizeItemOffsetMapping or useVariableSizeItemOffsetMapping to create implementations for common cases.

    layout?: ScrollLayout

    Choice of 'vertical' or 'horizontal' layouts

    'vertical'
    
    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.

    6000000
    
    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.

    100
    

    Scroll handler implementing VirtualListScrollHandler called after a scroll event has been processed and state updated.

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

    useIsScrolling?: boolean

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

    false
    
    width: number

    Component width