@memobit/libs 1.0.38 → 1.0.40

package/dist/index.d.ts

@@ -2887,6 +2887,39 @@ export declare interface VinValidationResult {
     error?: string;
 }
 
+/**
+ * Renders only the rows in view, so a list of tens of thousands of items costs
+ * the same handful of DOM nodes and React fibers as a short one. The rows that
+ * are not mounted are held open by spacer elements, which keeps the scrollbar,
+ * scroll offsets and wheel behaviour identical to a fully rendered list.
+ *
+ * Rows must all be the SAME HEIGHT — the list measures one and multiplies. Give
+ * variable-length content a fixed height in CSS (a line clamp on text, a fixed
+ * thumbnail size) or rows will drift out of step with the spacers.
+ */
+export declare function VirtualList<T>({ items, renderItem, getKey, rowHeight, overscan, maxHeight, empty, className, rowClassName, }: VirtualListProps<T>): JSX.Element | null;
+
+export declare interface VirtualListProps<T> {
+    items: T[];
+    /** Content of a single row. The row element itself is provided by the list. */
+    renderItem: (item: T, index: number) => ReactNode;
+    getKey: (item: T, index: number) => string | number;
+    /**
+     * Row stride in pixels (row height plus the gap below it). Leave unset to
+     * measure it from the first rendered rows, which keeps it in step with the
+     * active theme's font sizes.
+     */
+    rowHeight?: number;
+    /** Rows kept mounted above and below the viewport. Defaults to 6. */
+    overscan?: number;
+    /** Height cap for the scroller. Defaults to the value in the stylesheet. */
+    maxHeight?: number | string;
+    /** Rendered in place of the list when `items` is empty. */
+    empty?: ReactNode;
+    className?: string;
+    rowClassName?: string;
+}
+
 export declare const WHtR: default_2.FC<WHtRProps>;
 
 declare interface WHtRProps {