@tanstack/virtual-core 3.0.0-alpha.1

package/build/stats-react.json

@@ -0,0 +1,101 @@
+{
+  "version": 2,
+  "tree": {
+    "name": "root",
+    "children": [
+      {
+        "name": "index.production.js",
+        "children": [
+          {
+            "name": "node_modules/@reach/observe-rect/dist/observe-rect.esm.js",
+            "uid": "3f78-7"
+          },
+          {
+            "name": "packages/virtual-core/src",
+            "children": [
+              {
+                "uid": "3f78-9",
+                "name": "utils.ts"
+              },
+              {
+                "uid": "3f78-11",
+                "name": "index.ts"
+              }
+            ]
+          }
+        ]
+      }
+    ],
+    "isRoot": true
+  },
+  "nodeParts": {
+    "3f78-7": {
+      "renderedLength": 1732,
+      "gzipLength": 652,
+      "brotliLength": 0,
+      "mainUid": "3f78-6"
+    },
+    "3f78-9": {
+      "renderedLength": 1432,
+      "gzipLength": 544,
+      "brotliLength": 0,
+      "mainUid": "3f78-8"
+    },
+    "3f78-11": {
+      "renderedLength": 12529,
+      "gzipLength": 2895,
+      "brotliLength": 0,
+      "mainUid": "3f78-10"
+    }
+  },
+  "nodeMetas": {
+    "3f78-6": {
+      "id": "/node_modules/@reach/observe-rect/dist/observe-rect.esm.js",
+      "moduleParts": {
+        "index.production.js": "3f78-7"
+      },
+      "imported": [],
+      "importedBy": [
+        {
+          "uid": "3f78-10"
+        }
+      ]
+    },
+    "3f78-8": {
+      "id": "/packages/virtual-core/src/utils.ts",
+      "moduleParts": {
+        "index.production.js": "3f78-9"
+      },
+      "imported": [],
+      "importedBy": [
+        {
+          "uid": "3f78-10"
+        }
+      ]
+    },
+    "3f78-10": {
+      "id": "/packages/virtual-core/src/index.ts",
+      "moduleParts": {
+        "index.production.js": "3f78-11"
+      },
+      "imported": [
+        {
+          "uid": "3f78-6"
+        },
+        {
+          "uid": "3f78-8"
+        }
+      ],
+      "importedBy": [],
+      "isEntry": true
+    }
+  },
+  "env": {
+    "rollup": "2.75.4"
+  },
+  "options": {
+    "gzip": true,
+    "brotli": false,
+    "sourcemap": false
+  }
+}

package/build/types/index.d.ts

@@ -0,0 +1,87 @@
+export * from './utils';
+declare type ScrollAlignment = 'start' | 'center' | 'end' | 'auto';
+interface ScrollToOptions {
+    align: ScrollAlignment;
+}
+declare type ScrollToOffsetOptions = ScrollToOptions;
+declare type ScrollToIndexOptions = ScrollToOptions;
+export interface Range {
+    startIndex: number;
+    endIndex: number;
+    overscan: number;
+    count: number;
+}
+declare type Key = number | string;
+interface Item {
+    key: Key;
+    index: number;
+    start: number;
+    end: number;
+    size: number;
+}
+interface Rect {
+    width: number;
+    height: number;
+}
+export interface VirtualItem<TItemElement> extends Item {
+    measureElement: (el: TItemElement | null) => void;
+}
+export declare const defaultEstimateSize: () => number;
+export declare const defaultKeyExtractor: (index: number) => number;
+export declare const defaultRangeExtractor: (range: Range) => number[];
+export declare const observeElementRect: (instance: Virtualizer<any, any>, cb: (rect: Rect) => void) => (() => void) | undefined;
+export declare const observeWindowRect: (instance: Virtualizer<any, any>, cb: (rect: Rect) => void) => (() => void) | undefined;
+export declare const observeElementOffset: (instance: Virtualizer<any, any>, cb: (offset: number) => void) => (() => void) | undefined;
+export declare const observeWindowOffset: (instance: Virtualizer<any, any>, cb: (offset: number) => void) => (() => void) | undefined;
+export declare const defaultMeasureElement: (element: unknown, instance: Virtualizer<any, any>) => number;
+export declare const windowScroll: (offset: number, canSmooth: boolean, instance: Virtualizer<any, any>) => void;
+export declare const elementScroll: (offset: number, canSmooth: boolean, instance: Virtualizer<any, any>) => void;
+export interface VirtualizerOptions<TScrollElement = unknown, TItemElement = unknown> {
+    count: number;
+    scrollToFn: (offset: number, canSmooth: boolean, instance: Virtualizer<TScrollElement, TItemElement>) => void;
+    getScrollElement: () => TScrollElement;
+    observeElementRect: (instance: Virtualizer<TScrollElement, TItemElement>, cb: (rect: Rect) => void) => void | (() => void);
+    observeElementOffset: (instance: Virtualizer<TScrollElement, TItemElement>, cb: (offset: number) => void) => void | (() => void);
+    debug?: any;
+    initialRect?: Rect;
+    onChange?: (instance: Virtualizer<TScrollElement, TItemElement>) => void;
+    measureElement?: (el: TItemElement, instance: Virtualizer<TScrollElement, TItemElement>) => number;
+    estimateSize?: (index: number) => number;
+    overscan?: number;
+    horizontal?: boolean;
+    paddingStart?: number;
+    paddingEnd?: number;
+    initialOffset?: number;
+    keyExtractor?: (index: number) => Key;
+    rangeExtractor?: (range: Range) => number[];
+    enableSmoothScroll?: boolean;
+}
+export declare class Virtualizer<TScrollElement = unknown, TItemElement = unknown> {
+    unsubs: (void | (() => void))[];
+    options: Required<VirtualizerOptions<TScrollElement, TItemElement>>;
+    scrollElement: TScrollElement | null;
+    private measurementsCache;
+    private itemMeasurementsCache;
+    private pendingMeasuredCacheIndexes;
+    private scrollRect;
+    private scrollOffset;
+    constructor(opts: VirtualizerOptions<TScrollElement, TItemElement>);
+    setOptions: (opts: VirtualizerOptions<TScrollElement, TItemElement>) => void;
+    private notify;
+    private cleanup;
+    _didMount: () => () => void;
+    _willUpdate: () => void;
+    private getSize;
+    private getMeasurements;
+    private calculateRange;
+    private getIndexes;
+    getVirtualItems: () => VirtualItem<TItemElement>[];
+    scrollToOffset: (toOffset: number, { align }?: ScrollToOffsetOptions) => void;
+    private tryScrollToIndex;
+    scrollToIndex: (index: number, options?: ScrollToIndexOptions) => void;
+    getTotalSize: () => number;
+    getSizeKey: () => "width" | "height";
+    private _scrollToOffset;
+    private getEstimateSizeFn;
+    measure: () => void;
+}

package/build/types/utils.d.ts

@@ -0,0 +1,7 @@
+export declare type NoInfer<A extends any> = [A][A extends any ? 0 : never];
+export declare type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+export declare function memo<TDeps extends readonly any[], TResult>(getDeps: () => [...TDeps], fn: (...args: NoInfer<[...TDeps]>) => TResult, opts: {
+    key: any;
+    debug?: () => any;
+    onChange?: (result: TResult) => void;
+}): () => TResult;