@tanstack/virtual-core 3.0.0-beta.9 → 3.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present Tanner Linsley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/build/lib/_virtual/_rollupPluginBabelHelpers.esm.js

@@ -0,0 +1,27 @@
+/**
+ * virtual-core
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+export { _extends as extends };
+//# sourceMappingURL=_rollupPluginBabelHelpers.esm.js.map

package/build/lib/_virtual/_rollupPluginBabelHelpers.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_rollupPluginBabelHelpers.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/build/lib/_virtual/_rollupPluginBabelHelpers.js

@@ -0,0 +1,31 @@
+/**
+ * virtual-core
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+exports["extends"] = _extends;
+//# sourceMappingURL=_rollupPluginBabelHelpers.js.map

package/build/lib/_virtual/_rollupPluginBabelHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_rollupPluginBabelHelpers.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/build/lib/_virtual/_rollupPluginBabelHelpers.mjs

@@ -0,0 +1,27 @@
+/**
+ * virtual-core
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+function _extends() {
+  _extends = Object.assign ? Object.assign.bind() : function (target) {
+    for (var i = 1; i < arguments.length; i++) {
+      var source = arguments[i];
+      for (var key in source) {
+        if (Object.prototype.hasOwnProperty.call(source, key)) {
+          target[key] = source[key];
+        }
+      }
+    }
+    return target;
+  };
+  return _extends.apply(this, arguments);
+}
+
+export { _extends as extends };
+//# sourceMappingURL=_rollupPluginBabelHelpers.mjs.map

package/build/lib/_virtual/_rollupPluginBabelHelpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"_rollupPluginBabelHelpers.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/build/lib/index.d.ts

@@ -0,0 +1,126 @@
+export * from './utils';
+type ScrollDirection = 'forward' | 'backward';
+type ScrollAlignment = 'start' | 'center' | 'end' | 'auto';
+type ScrollBehavior = 'auto' | 'smooth';
+export interface ScrollToOptions {
+    align?: ScrollAlignment;
+    behavior?: ScrollBehavior;
+}
+type ScrollToOffsetOptions = ScrollToOptions;
+type ScrollToIndexOptions = ScrollToOptions;
+export interface Range {
+    startIndex: number;
+    endIndex: number;
+    overscan: number;
+    count: number;
+}
+type Key = number | string;
+export interface VirtualItem {
+    key: Key;
+    index: number;
+    start: number;
+    end: number;
+    size: number;
+    lane: number;
+}
+interface Rect {
+    width: number;
+    height: number;
+}
+export declare const defaultKeyExtractor: (index: number) => number;
+export declare const defaultRangeExtractor: (range: Range) => number[];
+export declare const observeElementRect: <T extends Element>(instance: Virtualizer<T, any>, cb: (rect: Rect) => void) => (() => void) | undefined;
+export declare const observeWindowRect: (instance: Virtualizer<Window, any>, cb: (rect: Rect) => void) => (() => void) | undefined;
+export declare const observeElementOffset: <T extends Element>(instance: Virtualizer<T, any>, cb: (offset: number) => void) => (() => void) | undefined;
+export declare const observeWindowOffset: (instance: Virtualizer<Window, any>, cb: (offset: number) => void) => (() => void) | undefined;
+export declare const measureElement: <TItemElement extends Element>(element: TItemElement, entry: ResizeObserverEntry | undefined, instance: Virtualizer<any, TItemElement>) => number;
+export declare const windowScroll: <T extends Window>(offset: number, { adjustments, behavior, }: {
+    adjustments?: number | undefined;
+    behavior?: ScrollBehavior | undefined;
+}, instance: Virtualizer<T, any>) => void;
+export declare const elementScroll: <T extends Element>(offset: number, { adjustments, behavior, }: {
+    adjustments?: number | undefined;
+    behavior?: ScrollBehavior | undefined;
+}, instance: Virtualizer<T, any>) => void;
+export interface VirtualizerOptions<TScrollElement extends Element | Window, TItemElement extends Element> {
+    count: number;
+    getScrollElement: () => TScrollElement | null;
+    estimateSize: (index: number) => number;
+    scrollToFn: (offset: number, options: {
+        adjustments?: number;
+        behavior?: ScrollBehavior;
+    }, instance: Virtualizer<TScrollElement, TItemElement>) => void;
+    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>, sync: boolean) => void;
+    measureElement?: (element: TItemElement, entry: ResizeObserverEntry | undefined, instance: Virtualizer<TScrollElement, TItemElement>) => number;
+    overscan?: number;
+    horizontal?: boolean;
+    paddingStart?: number;
+    paddingEnd?: number;
+    scrollPaddingStart?: number;
+    scrollPaddingEnd?: number;
+    initialOffset?: number;
+    getItemKey?: (index: number) => Key;
+    rangeExtractor?: (range: Range) => number[];
+    scrollMargin?: number;
+    scrollingDelay?: number;
+    indexAttribute?: string;
+    initialMeasurementsCache?: VirtualItem[];
+    lanes?: number;
+}
+export declare class Virtualizer<TScrollElement extends Element | Window, TItemElement extends Element> {
+    private unsubs;
+    options: Required<VirtualizerOptions<TScrollElement, TItemElement>>;
+    scrollElement: TScrollElement | null;
+    isScrolling: boolean;
+    private isScrollingTimeoutId;
+    private scrollToIndexTimeoutId;
+    measurementsCache: VirtualItem[];
+    private itemSizeCache;
+    private pendingMeasuredCacheIndexes;
+    scrollRect: Rect;
+    scrollOffset: number;
+    scrollDirection: ScrollDirection | null;
+    private scrollAdjustments;
+    measureElementCache: Map<Key, TItemElement>;
+    private observer;
+    range: {
+        startIndex: number;
+        endIndex: number;
+    } | null;
+    constructor(opts: VirtualizerOptions<TScrollElement, TItemElement>);
+    setOptions: (opts: VirtualizerOptions<TScrollElement, TItemElement>) => void;
+    private notify;
+    private maybeNotify;
+    private cleanup;
+    _didMount: () => () => void;
+    _willUpdate: () => void;
+    private getSize;
+    private memoOptions;
+    private getFurthestMeasurement;
+    private getMeasurements;
+    calculateRange: () => {
+        startIndex: number;
+        endIndex: number;
+    } | null;
+    private getIndexes;
+    indexFromElement: (node: TItemElement) => number;
+    private _measureElement;
+    resizeItem: (item: VirtualItem, size: number) => void;
+    measureElement: (node: TItemElement | null) => void;
+    getVirtualItems: () => VirtualItem[];
+    getVirtualItemForOffset: (offset: number) => VirtualItem;
+    getOffsetForAlignment: (toOffset: number, align: ScrollAlignment) => number;
+    getOffsetForIndex: (index: number, align?: ScrollAlignment) => readonly [number, "auto"] | readonly [number, "start" | "center" | "end"];
+    private isDynamicMode;
+    private cancelScrollToIndex;
+    scrollToOffset: (toOffset: number, { align, behavior }?: ScrollToOffsetOptions) => void;
+    scrollToIndex: (index: number, { align: initialAlign, behavior }?: ScrollToIndexOptions) => void;
+    scrollBy: (delta: number, { behavior }?: ScrollToOffsetOptions) => void;
+    getTotalSize: () => number;
+    private _scrollToOffset;
+    measure: () => void;
+}