The Candid Startup
    Preparing search index...

    Interface DisplayListProps

    Props accepted by DisplayList

    interface DisplayListProps {
        children: DisplayListItem;
        className?: string;
        height: number;
        innerClassName?: string;
        innerRender?: VirtualContainerRender;
        isScrolling?: boolean;
        itemCount: number;
        itemData?: unknown;
        itemKey?: ListItemKey;
        itemOffsetMapping: ItemOffsetMapping;
        layout?: ScrollLayout;
        offset: number;
        outerRender?: VirtualContainerRender;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    children className? height innerClassName? innerRender? isScrolling? itemCount itemData? itemKey? itemOffsetMapping layout? offset outerRender? width

    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.

    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

    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'
    offset: number

    Offset to start of displayed content

    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.

    width: number

    Component width

    Settings

    Member Visibility

    On This Page

    Properties