The Candid Startup
    Preparing search index...

    Interface VirtualGridProps

    Props accepted by VirtualGrid

    interface VirtualGridProps {
        children: DisplayGridItem;
        className?: string;
        columnCount: number;
        columnOffsetMapping: ItemOffsetMapping;
        height: number;
        innerClassName?: string;
        innerRender?: VirtualContainerRender;
        itemData?: unknown;
        itemKey?: GridItemKey;
        maxCssSize?: number;
        minNumPages?: number;
        onScroll?: VirtualGridScrollHandler;
        outerRender?: VirtualContainerRender;
        rowCount: number;
        rowOffsetMapping: ItemOffsetMapping;
        useIsScrolling?: boolean;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children className? columnCount columnOffsetMapping height innerClassName? innerRender? itemData? itemKey? maxCssSize? minNumPages? onScroll? outerRender? rowCount rowOffsetMapping useIsScrolling? width

    Properties

    children: DisplayGridItem

    Component used as a template to render items in the grid. Must implement DisplayGridItem interface.

    className?: string

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

    columnCount: number

    Number of columns in the grid

    columnOffsetMapping: ItemOffsetMapping

    Implementation of ItemOffsetMapping interface that defines size and offset to each column in the grid

    Use useFixedSizeItemOffsetMapping or useVariableSizeItemOffsetMapping to create implementations for common cases.

    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.

    innerRender?: VirtualContainerRender

    Render prop implementing VirtualContainerRender. Used to customize DisplayGrid within VirtualGrid inner container.

    itemData?: unknown

    Passed as DisplayBaseItemProps.data to each child item

    itemKey?: GridItemKey

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

    (rowIndex, columnIndex, _data) => '${rowIndex}:${columnIndex}'

    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
    onScroll?: VirtualGridScrollHandler

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

    outerRender?: VirtualContainerRender

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

    rowCount: number

    Number of rows in the grid

    rowOffsetMapping: ItemOffsetMapping

    Implementation of ItemOffsetMapping interface that defines size and offset to each row in the grid

    Use useFixedSizeItemOffsetMapping or useVariableSizeItemOffsetMapping to create implementations for common cases.

    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

    Settings

    Member Visibility

    On This Page

    Properties