effex-monorepo
    Preparing search index...

    Interface VirtualEachOptions<A, E, R>

    Options for virtualEach.

    interface VirtualEachOptions<A, E = never, R = never> {
        animate?: ListAnimationOptions;
        estimatedHeight?: number;
        height?: string | number;
        itemHeight?: number;
        key: (item: A) => string;
        onVisibleRangeChange?: (
            range: VisibleRange,
        ) => void | Effect<void, never, never>;
        overscan?: number;
        ref?: VirtualListRefType;
        render: (
            item: Signal.Signal<A>,
            index: Signal.Signal<number>,
        ) => Element<HTMLElement | SVGElement, E, R>;
    }

    Type Parameters

    • A
    • E = never
    • R = never
    Index

    Properties

    animate? estimatedHeight? height? itemHeight? key onVisibleRangeChange? overscan? ref? render

    Properties

    animate?: ListAnimationOptions

    Animation options for items entering/exiting the viewport.

    estimatedHeight?: number

    Estimated height for variable-height items. The list will measure actual heights and adjust positioning. Either itemHeight or estimatedHeight must be provided.

    height?: string | number

    Height of the scrollable viewport. Can be a number (pixels) or CSS string like "100%" or "400px". Default: "100%" (fills parent container)

    itemHeight?: number

    Fixed height for all items in pixels. Use this for best performance when all items have the same height. Either itemHeight or estimatedHeight must be provided.

    key: (item: A) => string

    Function to extract a unique key from each item. Used for efficient updates and item identity.

    onVisibleRangeChange?: (
        range: VisibleRange,
    ) => void | Effect<void, never, never>

    Callback when the visible range changes.

    overscan?: number

    Number of items to render above/below the visible area. Higher values reduce flicker during fast scrolling but use more memory. Default: 3

    ref?: VirtualListRefType

    Optional ref to access scroll control methods. Create with VirtualListRef.make()

    render: (
        item: Signal.Signal<A>,
        index: Signal.Signal<number>,
    ) => Element<HTMLElement | SVGElement, E, R>

    Render function for each item. Receives a Signal for the item data and its index.

    Settings

    Member Visibility

    On This Page

    Properties