@tanstack/solid-virtual 3.0.0-beta.9 → 3.0.0

package/src/index.tsx

@@ -8,97 +8,127 @@ import {
   Virtualizer,
   VirtualizerOptions,
   windowScroll,
-} from '@tanstack/virtual-core';
-export * from '@tanstack/virtual-core';
+} from '@tanstack/virtual-core'
+export * from '@tanstack/virtual-core'
 
-import { createSignal, onMount, onCleanup, createComputed, mergeProps } from 'solid-js';
-import { createStore, reconcile } from 'solid-js/store';
+import {
+  createSignal,
+  onMount,
+  onCleanup,
+  createComputed,
+  mergeProps,
+} from 'solid-js'
+import { createStore, reconcile } from 'solid-js/store'
 
-function createVirtualizerBase<TScrollElement, TItemElement = unknown>(
-  options: VirtualizerOptions<TScrollElement, TItemElement>
+function createVirtualizerBase<
+  TScrollElement extends Element | Window,
+  TItemElement extends Element,
+>(
+  options: VirtualizerOptions<TScrollElement, TItemElement>,
 ): Virtualizer<TScrollElement, TItemElement> {
-  const resolvedOptions: VirtualizerOptions<TScrollElement, TItemElement> = mergeProps(options);
+  const resolvedOptions: VirtualizerOptions<TScrollElement, TItemElement> =
+    mergeProps(options)
 
   const instance = new Virtualizer<TScrollElement, TItemElement>(
-    resolvedOptions
-  );
+    resolvedOptions,
+  )
 
   const [virtualItems, setVirtualItems] = createStore(
-    instance.getVirtualItems()
-  );
-  const [totalSize, setTotalSize] = createSignal(instance.getTotalSize());
+    instance.getVirtualItems(),
+  )
+  const [totalSize, setTotalSize] = createSignal(instance.getTotalSize())
 
   const handler = {
     get(
       target: Virtualizer<TScrollElement, TItemElement>,
-      prop: keyof Virtualizer<TScrollElement, TItemElement>
+      prop: keyof Virtualizer<TScrollElement, TItemElement>,
     ) {
       switch (prop) {
         case 'getVirtualItems':
-          return () => virtualItems;
+          return () => virtualItems
         case 'getTotalSize':
-          return () => totalSize();
+          return () => totalSize()
         default:
-          return Reflect.get(target, prop);
+          return Reflect.get(target, prop)
       }
     },
-  };
+  }
 
-  const virtualizer = new Proxy(instance, handler);
-  virtualizer.setOptions(resolvedOptions);
+  const virtualizer = new Proxy(instance, handler)
+  virtualizer.setOptions(resolvedOptions)
 
   onMount(() => {
-    const cleanup = virtualizer._didMount();
-    virtualizer._willUpdate();
-    onCleanup(cleanup);
-  });
+    const cleanup = virtualizer._didMount()
+    virtualizer._willUpdate()
+    onCleanup(cleanup)
+  })
 
   createComputed(() => {
-    virtualizer.setOptions(mergeProps(resolvedOptions, options, {
-      onChange: (instance: Virtualizer<TScrollElement, TItemElement> ) => {
-      instance._willUpdate();
-      setVirtualItems(
-        reconcile(instance.getVirtualItems(), {
-          key: 'index',
-        })
-      );
-      setTotalSize(instance.getTotalSize());
-      options.onChange?.(instance);
-    }}))
+    virtualizer.setOptions(
+      mergeProps(resolvedOptions, options, {
+        onChange: (
+          instance: Virtualizer<TScrollElement, TItemElement>,
+          sync: boolean,
+        ) => {
+          instance._willUpdate()
+          setVirtualItems(
+            reconcile(instance.getVirtualItems(), {
+              key: 'index',
+            }),
+          )
+          setTotalSize(instance.getTotalSize())
+          options.onChange?.(instance, sync)
+        },
+      }),
+    )
     virtualizer.measure()
   })
 
-  return virtualizer;
+  return virtualizer
 }
 
-export function createVirtualizer<TScrollElement, TItemElement = unknown>(
+export function createVirtualizer<
+  TScrollElement extends Element,
+  TItemElement extends Element,
+>(
   options: PartialKeys<
     VirtualizerOptions<TScrollElement, TItemElement>,
     'observeElementRect' | 'observeElementOffset' | 'scrollToFn'
-  >
+  >,
 ): Virtualizer<TScrollElement, TItemElement> {
-  
-  return createVirtualizerBase<TScrollElement, TItemElement>(mergeProps({
-    observeElementRect: observeElementRect,
-    observeElementOffset: observeElementOffset,
-    scrollToFn: elementScroll
-  }, options));
+  return createVirtualizerBase<TScrollElement, TItemElement>(
+    mergeProps(
+      {
+        observeElementRect: observeElementRect,
+        observeElementOffset: observeElementOffset,
+        scrollToFn: elementScroll,
+      },
+      options,
+    ),
+  )
 }
 
-export function createWindowVirtualizer<TItemElement = unknown>(
+export function createWindowVirtualizer<TItemElement extends Element>(
   options: PartialKeys<
     VirtualizerOptions<Window, TItemElement>,
     | 'getScrollElement'
     | 'observeElementRect'
     | 'observeElementOffset'
     | 'scrollToFn'
-  >
+  >,
 ): Virtualizer<Window, TItemElement> {
-  return createVirtualizerBase<Window, TItemElement>(mergeProps({
-    getScrollElement: () => (typeof window !== 'undefined' ? window : null!),
-    observeElementRect: observeWindowRect,
-    observeElementOffset: observeWindowOffset,
-    scrollToFn: windowScroll,
-  },options,
-  ));
+  return createVirtualizerBase<Window, TItemElement>(
+    mergeProps(
+      {
+        getScrollElement: () =>
+          typeof document !== 'undefined' ? window : null,
+        observeElementRect: observeWindowRect,
+        observeElementOffset: observeWindowOffset,
+        scrollToFn: windowScroll,
+        initialOffset:
+          typeof document !== 'undefined' ? window.scrollY : undefined,
+      },
+      options,
+    ),
+  )
 }

package/build/cjs/solid-virtual/src/index.js

@@ -1,94 +0,0 @@
-/**
- * solid-virtual
- *
- * 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 });
-
-var index = require('../../virtual-core/build/esm/index.js');
-var solidJs = require('solid-js');
-var store = require('solid-js/store');
-
-function createVirtualizerBase(options) {
-  const resolvedOptions = solidJs.mergeProps(options);
-  const instance = new index.Virtualizer(resolvedOptions);
-  const [virtualItems, setVirtualItems] = store.createStore(instance.getVirtualItems());
-  const [totalSize, setTotalSize] = solidJs.createSignal(instance.getTotalSize());
-  const handler = {
-    get(target, prop) {
-      switch (prop) {
-        case 'getVirtualItems':
-          return () => virtualItems;
-
-        case 'getTotalSize':
-          return () => totalSize();
-
-        default:
-          return Reflect.get(target, prop);
-      }
-    }
-
-  };
-  const virtualizer = new Proxy(instance, handler);
-  virtualizer.setOptions(resolvedOptions);
-  solidJs.onMount(() => {
-    const cleanup = virtualizer._didMount();
-
-    virtualizer._willUpdate();
-
-    solidJs.onCleanup(cleanup);
-  });
-  solidJs.createComputed(() => {
-    virtualizer.setOptions(solidJs.mergeProps(resolvedOptions, options, {
-      onChange: instance => {
-        instance._willUpdate();
-
-        setVirtualItems(store.reconcile(instance.getVirtualItems(), {
-          key: 'index'
-        }));
-        setTotalSize(instance.getTotalSize());
-        options.onChange == null ? void 0 : options.onChange(instance);
-      }
-    }));
-    virtualizer.measure();
-  });
-  return virtualizer;
-}
-
-function createVirtualizer(options) {
-  return createVirtualizerBase(solidJs.mergeProps({
-    observeElementRect: index.observeElementRect,
-    observeElementOffset: index.observeElementOffset,
-    scrollToFn: index.elementScroll
-  }, options));
-}
-function createWindowVirtualizer(options) {
-  return createVirtualizerBase(solidJs.mergeProps({
-    getScrollElement: () => typeof window !== 'undefined' ? window : null,
-    observeElementRect: index.observeWindowRect,
-    observeElementOffset: index.observeWindowOffset,
-    scrollToFn: index.windowScroll
-  }, options));
-}
-
-exports.Virtualizer = index.Virtualizer;
-exports.defaultKeyExtractor = index.defaultKeyExtractor;
-exports.defaultRangeExtractor = index.defaultRangeExtractor;
-exports.elementScroll = index.elementScroll;
-exports.measureElement = index.measureElement;
-exports.memo = index.memo;
-exports.observeElementOffset = index.observeElementOffset;
-exports.observeElementRect = index.observeElementRect;
-exports.observeWindowOffset = index.observeWindowOffset;
-exports.observeWindowRect = index.observeWindowRect;
-exports.windowScroll = index.windowScroll;
-exports.createVirtualizer = createVirtualizer;
-exports.createWindowVirtualizer = createWindowVirtualizer;
-//# sourceMappingURL=index.js.map

package/build/cjs/solid-virtual/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../../../../src/index.tsx"],"sourcesContent":["import {\n  elementScroll,\n  observeElementOffset,\n  observeElementRect,\n  observeWindowOffset,\n  observeWindowRect,\n  PartialKeys,\n  Virtualizer,\n  VirtualizerOptions,\n  windowScroll,\n} from '@tanstack/virtual-core';\nexport * from '@tanstack/virtual-core';\n\nimport { createSignal, onMount, onCleanup, createComputed, mergeProps } from 'solid-js';\nimport { createStore, reconcile } from 'solid-js/store';\n\nfunction createVirtualizerBase<TScrollElement, TItemElement = unknown>(\n  options: VirtualizerOptions<TScrollElement, TItemElement>\n): Virtualizer<TScrollElement, TItemElement> {\n  const resolvedOptions: VirtualizerOptions<TScrollElement, TItemElement> = mergeProps(options);\n\n  const instance = new Virtualizer<TScrollElement, TItemElement>(\n    resolvedOptions\n  );\n\n  const [virtualItems, setVirtualItems] = createStore(\n    instance.getVirtualItems()\n  );\n  const [totalSize, setTotalSize] = createSignal(instance.getTotalSize());\n\n  const handler = {\n    get(\n      target: Virtualizer<TScrollElement, TItemElement>,\n      prop: keyof Virtualizer<TScrollElement, TItemElement>\n    ) {\n      switch (prop) {\n        case 'getVirtualItems':\n          return () => virtualItems;\n        case 'getTotalSize':\n          return () => totalSize();\n        default:\n          return Reflect.get(target, prop);\n      }\n    },\n  };\n\n  const virtualizer = new Proxy(instance, handler);\n  virtualizer.setOptions(resolvedOptions);\n\n  onMount(() => {\n    const cleanup = virtualizer._didMount();\n    virtualizer._willUpdate();\n    onCleanup(cleanup);\n  });\n\n  createComputed(() => {\n    virtualizer.setOptions(mergeProps(resolvedOptions, options, {\n      onChange: (instance: Virtualizer<TScrollElement, TItemElement> ) => {\n      instance._willUpdate();\n      setVirtualItems(\n        reconcile(instance.getVirtualItems(), {\n          key: 'index',\n        })\n      );\n      setTotalSize(instance.getTotalSize());\n      options.onChange?.(instance);\n    }}))\n    virtualizer.measure()\n  })\n\n  return virtualizer;\n}\n\nexport function createVirtualizer<TScrollElement, TItemElement = unknown>(\n  options: PartialKeys<\n    VirtualizerOptions<TScrollElement, TItemElement>,\n    'observeElementRect' | 'observeElementOffset' | 'scrollToFn'\n  >\n): Virtualizer<TScrollElement, TItemElement> {\n  \n  return createVirtualizerBase<TScrollElement, TItemElement>(mergeProps({\n    observeElementRect: observeElementRect,\n    observeElementOffset: observeElementOffset,\n    scrollToFn: elementScroll\n  }, options));\n}\n\nexport function createWindowVirtualizer<TItemElement = unknown>(\n  options: PartialKeys<\n    VirtualizerOptions<Window, TItemElement>,\n    | 'getScrollElement'\n    | 'observeElementRect'\n    | 'observeElementOffset'\n    | 'scrollToFn'\n  >\n): Virtualizer<Window, TItemElement> {\n  return createVirtualizerBase<Window, TItemElement>(mergeProps({\n    getScrollElement: () => (typeof window !== 'undefined' ? window : null!),\n    observeElementRect: observeWindowRect,\n    observeElementOffset: observeWindowOffset,\n    scrollToFn: windowScroll,\n  },options,\n  ));\n}\n"],"names":["createVirtualizerBase","options","resolvedOptions","mergeProps","instance","Virtualizer","virtualItems","setVirtualItems","createStore","getVirtualItems","totalSize","setTotalSize","createSignal","getTotalSize","handler","get","target","prop","Reflect","virtualizer","Proxy","setOptions","onMount","cleanup","_didMount","_willUpdate","onCleanup","createComputed","onChange","reconcile","key","measure","createVirtualizer","observeElementRect","observeElementOffset","scrollToFn","elementScroll","createWindowVirtualizer","getScrollElement","window","observeWindowRect","observeWindowOffset","windowScroll"],"mappings":";;;;;;;;;;;;;;;;;;AAgBA,SAASA,qBAAT,CACEC,OADF,EAE6C;AAC3C,EAAA,MAAMC,eAAiE,GAAGC,kBAAU,CAACF,OAAD,CAApF,CAAA;AAEA,EAAA,MAAMG,QAAQ,GAAG,IAAIC,iBAAJ,CACfH,eADe,CAAjB,CAAA;EAIA,MAAM,CAACI,YAAD,EAAeC,eAAf,CAAA,GAAkCC,iBAAW,CACjDJ,QAAQ,CAACK,eAAT,EADiD,CAAnD,CAAA;EAGA,MAAM,CAACC,SAAD,EAAYC,YAAZ,CAAA,GAA4BC,oBAAY,CAACR,QAAQ,CAACS,YAAT,EAAD,CAA9C,CAAA;AAEA,EAAA,MAAMC,OAAO,GAAG;AACdC,IAAAA,GAAG,CACDC,MADC,EAEDC,IAFC,EAGD;AACA,MAAA,QAAQA,IAAR;AACE,QAAA,KAAK,iBAAL;AACE,UAAA,OAAO,MAAMX,YAAb,CAAA;;AACF,QAAA,KAAK,cAAL;UACE,OAAO,MAAMI,SAAS,EAAtB,CAAA;;AACF,QAAA;AACE,UAAA,OAAOQ,OAAO,CAACH,GAAR,CAAYC,MAAZ,EAAoBC,IAApB,CAAP,CAAA;AANJ,OAAA;AAQD,KAAA;;GAbH,CAAA;EAgBA,MAAME,WAAW,GAAG,IAAIC,KAAJ,CAAUhB,QAAV,EAAoBU,OAApB,CAApB,CAAA;EACAK,WAAW,CAACE,UAAZ,CAAuBnB,eAAvB,CAAA,CAAA;AAEAoB,EAAAA,eAAO,CAAC,MAAM;AACZ,IAAA,MAAMC,OAAO,GAAGJ,WAAW,CAACK,SAAZ,EAAhB,CAAA;;AACAL,IAAAA,WAAW,CAACM,WAAZ,EAAA,CAAA;;IACAC,iBAAS,CAACH,OAAD,CAAT,CAAA;AACD,GAJM,CAAP,CAAA;AAMAI,EAAAA,sBAAc,CAAC,MAAM;IACnBR,WAAW,CAACE,UAAZ,CAAuBlB,kBAAU,CAACD,eAAD,EAAkBD,OAAlB,EAA2B;MAC1D2B,QAAQ,EAAGxB,QAAD,IAA0D;AACpEA,QAAAA,QAAQ,CAACqB,WAAT,EAAA,CAAA;;AACAlB,QAAAA,eAAe,CACbsB,eAAS,CAACzB,QAAQ,CAACK,eAAT,EAAD,EAA6B;AACpCqB,UAAAA,GAAG,EAAE,OAAA;AAD+B,SAA7B,CADI,CAAf,CAAA;AAKAnB,QAAAA,YAAY,CAACP,QAAQ,CAACS,YAAT,EAAD,CAAZ,CAAA;AACAZ,QAAAA,OAAO,CAAC2B,QAAR,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA3B,OAAO,CAAC2B,QAAR,CAAmBxB,QAAnB,CAAA,CAAA;AACD,OAAA;AAV2D,KAA3B,CAAjC,CAAA,CAAA;AAWAe,IAAAA,WAAW,CAACY,OAAZ,EAAA,CAAA;AACD,GAba,CAAd,CAAA;AAeA,EAAA,OAAOZ,WAAP,CAAA;AACD,CAAA;;AAEM,SAASa,iBAAT,CACL/B,OADK,EAKsC;EAE3C,OAAOD,qBAAqB,CAA+BG,kBAAU,CAAC;AACpE8B,IAAAA,kBAAkB,EAAEA,wBADgD;AAEpEC,IAAAA,oBAAoB,EAAEA,0BAF8C;AAGpEC,IAAAA,UAAU,EAAEC,mBAAAA;GAHuD,EAIlEnC,OAJkE,CAAzC,CAA5B,CAAA;AAKD,CAAA;AAEM,SAASoC,uBAAT,CACLpC,OADK,EAQ8B;EACnC,OAAOD,qBAAqB,CAAuBG,kBAAU,CAAC;IAC5DmC,gBAAgB,EAAE,MAAO,OAAOC,MAAP,KAAkB,WAAlB,GAAgCA,MAAhC,GAAyC,IADN;AAE5DN,IAAAA,kBAAkB,EAAEO,uBAFwC;AAG5DN,IAAAA,oBAAoB,EAAEO,yBAHsC;AAI5DN,IAAAA,UAAU,EAAEO,kBAAAA;GAJ+C,EAK3DzC,OAL2D,CAAjC,CAA5B,CAAA;AAOD;;;;;;;;;;;;;;;;"}