import { Virtualizer, elementScroll, observeElementOffset, observeElementRect, type PartialKeys, type VirtualizerOptions } from "@tanstack/virtual-core"; import { untrack } from "svelte"; export type { VirtualItem } from "@tanstack/virtual-core"; /** * Creates a reactive TanStack Virtualizer for Svelte 5. * * Returns a getter function that returns the virtualizer instance. * Call the getter inside $derived or template expressions to create * reactive dependencies on the virtualizer state. */ export function createSvelteVirtualizer< TScrollElement extends Element, TItemElement extends Element >( options: PartialKeys< VirtualizerOptions, "observeElementRect" | "observeElementOffset" | "scrollToFn" > ): { instance: Virtualizer; virtualItems: () => ReturnType< Virtualizer["getVirtualItems"] >; totalSize: () => number; } { let version = $state(0); const virtualizer = new Virtualizer({ observeElementRect: observeElementRect, observeElementOffset: observeElementOffset, scrollToFn: elementScroll, ...options, onChange: (instance, sync) => { if (sync) { version += 1; } else { queueMicrotask(() => { version += 1; }); } options.onChange?.(instance, sync); } }); $effect(() => { const cleanup = virtualizer._didMount(); untrack(() => { version += 1; }); return cleanup; }); let prev_count = 0; $effect(() => { const current_count = options.count; virtualizer.setOptions({ observeElementRect: observeElementRect, observeElementOffset: observeElementOffset, scrollToFn: elementScroll, ...options, onChange: (instance, sync) => { if (sync) { version += 1; } else { queueMicrotask(() => { version += 1; }); } options.onChange?.(instance, sync); } }); if (prev_count === 0 && current_count > 0) { virtualizer.measure(); } prev_count = current_count; }); $effect.pre(() => { void version; virtualizer._willUpdate(); }); return { instance: virtualizer, virtualItems: () => { void version; return virtualizer.getVirtualItems(); }, totalSize: () => { void version; return virtualizer.getTotalSize(); } }; }