The Candid Startup
    Preparing search index...

    Interface DisplayGridProps

    Props accepted by DisplayGrid

    interface DisplayGridProps {
        children: DisplayGridItem;
        className?: string;
        columnCount: number;
        columnOffset: number;
        columnOffsetMapping: ItemOffsetMapping;
        height: number;
        innerClassName?: string;
        innerRender?: VirtualContainerRender;
        isScrolling?: boolean;
        itemData?: unknown;
        itemKey?: GridItemKey;
        outerRender?: VirtualContainerRender;
        rowCount: number;
        rowOffset: number;
        rowOffsetMapping: ItemOffsetMapping;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children className? columnCount columnOffset columnOffsetMapping height innerClassName? innerRender? isScrolling? itemData? itemKey? outerRender? rowCount rowOffset rowOffsetMapping width

    Properties

    children: DisplayGridItem

    Component used as a template to render items in the list. 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

    columnOffset: number

    Horizontal offset to start of displayed content

    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

    Renders the inner grid div containing all the list items

    Render prop implementing VirtualContainerRender. Used to customize display component inner container.

    isScrolling?: boolean

    Passed as DisplayBaseItemProps.isScrolling to each child item

    Provided as a convenience when combining display components with VirtualScroll Not interpreted by the display component itself

    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}'

    outerRender?: VirtualContainerRender

    Renders the outer viewport div which provides a window onto the inner grid div

    Render prop implementing VirtualContainerRender. Used to customize display component outer container.

    rowCount: number

    Number of rows in the grid

    rowOffset: number

    Vertical offset to start of displayed content

    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.

    width: number

    Component width

    Settings

    Member Visibility

    On This Page

    Properties