/** * @jsxImportSource solid-js */ import { onMount, onCleanup, createEffect, createSignal, createMemo, JSX, on, createComputed, type ValidComponent, mergeProps, } from "solid-js"; import { Dynamic } from "solid-js/web"; import { UPDATE_SCROLL_EVENT, UPDATE_SCROLL_END_EVENT, UPDATE_VIRTUAL_STATE, createVirtualStore, ACTION_ITEMS_LENGTH_CHANGE, getScrollSize, ACTION_START_OFFSET_CHANGE, createResizer, createScroller, ItemsRange, ScrollToIndexOpts, ItemSize, } from "../core"; import { ListItem } from "./ListItem"; import { RangedFor } from "./RangedFor"; import { isSameRange } from "./utils"; /** * Methods of {@link Virtualizer}. */ export interface VirtualizerHandle { /** * Get current scrollTop, or scrollLeft if horizontal: true. */ readonly scrollOffset: number; /** * Get current scrollHeight, or scrollWidth if horizontal: true. */ readonly scrollSize: number; /** * Get current offsetHeight, or offsetWidth if horizontal: true. */ readonly viewportSize: number; /** * Find the start index of visible range of items. */ findStartIndex: () => number; /** * Find the end index of visible range of items. */ findEndIndex: () => number; /** * Get item offset from start. * @param index index of item */ getItemOffset(index: number): number; /** * Get item size. * @param index index of item */ getItemSize(index: number): number; /** * Scroll to the item specified by index. * @param index index of item * @param opts options */ scrollToIndex(index: number, opts?: ScrollToIndexOpts): void; /** * Scroll to the given offset. * @param offset offset from start */ scrollTo(offset: number): void; /** * Scroll by the given offset. * @param offset offset from current position */ scrollBy(offset: number): void; } /** * Props of {@link Virtualizer}. */ export interface VirtualizerProps { /** * Get reference to {@link VirtualizerHandle}. */ ref?: (handle?: VirtualizerHandle) => void; /** * The data items rendered by this component. */ data: T[]; /** * The elements renderer function. */ children: (data: T, index: number) => JSX.Element; /** * Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling. * @defaultValue 4 */ overscan?: number; /** * Component or element type for container element. * @defaultValue "div" */ as?: ValidComponent; /** * Component or element type for item element. * @defaultValue "div" */ item?: ValidComponent; /** * Reference to the scrollable element. The default will get the direct parent element of virtualizer. */ scrollRef?: HTMLElement; /** * Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly. * * - If not set, initial item sizes will be automatically estimated from measured sizes. This is recommended for most cases. * - If set, you can opt out estimation and use the value as initial item size. */ itemSize?: ItemSize; /** * While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling. */ shift?: boolean; /** * If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list. */ horizontal?: boolean; /** * If you put an element before virtualizer, you have to define its height with this prop. */ startMargin?: number; /** * Callback invoked whenever scroll offset changes. * @param offset Current scrollTop, or scrollLeft if horizontal: true. */ onScroll?: (offset: number) => void; /** * Callback invoked when scrolling stops. */ onScrollEnd?: () => void; } /** * Customizable list virtualizer for advanced usage. See {@link VirtualizerProps} and {@link VirtualizerHandle}. */ export const Virtualizer = (props: VirtualizerProps): JSX.Element => { let containerRef: HTMLDivElement | undefined; const { itemSize, horizontal = false, overscan } = props; props = mergeProps<[Partial>, VirtualizerProps]>( { as: "div" }, props ); const store = createVirtualStore( props.data.length, itemSize, overscan, undefined, undefined, !itemSize ); const resizer = createResizer(store, horizontal); const scroller = createScroller(store, horizontal); const [stateVersion, setRerender] = createSignal(store.$getStateVersion()); const unsubscribeStore = store.$subscribe(UPDATE_VIRTUAL_STATE, () => { setRerender(store.$getStateVersion()); }); const unsubscribeOnScroll = store.$subscribe(UPDATE_SCROLL_EVENT, () => { props.onScroll?.(store.$getScrollOffset()); }); const unsubscribeOnScrollEnd = store.$subscribe( UPDATE_SCROLL_END_EVENT, () => { props.onScrollEnd?.(); } ); const range = createMemo((prev) => { stateVersion(); const next = store.$getRange(); if (prev && isSameRange(prev, next)) { return prev; } return next; }); const isScrolling = createMemo(() => stateVersion() && store.$isScrolling()); const totalSize = createMemo(() => stateVersion() && store.$getTotalSize()); onMount(() => { if (props.ref) { props.ref({ get scrollOffset() { return store.$getScrollOffset(); }, get scrollSize() { return getScrollSize(store); }, get viewportSize() { return store.$getViewportSize(); }, findStartIndex: store.$findStartIndex, findEndIndex: store.$findEndIndex, getItemOffset: store.$getItemOffset, getItemSize: store.$getItemSize, scrollToIndex: scroller.$scrollToIndex, scrollTo: scroller.$scrollTo, scrollBy: scroller.$scrollBy, }); } const scrollable = props.scrollRef || containerRef!.parentElement!; resizer.$observeRoot(scrollable); scroller.$observe(scrollable); onCleanup(() => { if (props.ref) { props.ref(); } unsubscribeStore(); unsubscribeOnScroll(); unsubscribeOnScrollEnd(); resizer.$dispose(); scroller.$dispose(); }); }); createComputed( on( () => props.data.length, (count) => { if (count !== store.$getItemsLength()) { store.$update(ACTION_ITEMS_LENGTH_CHANGE, [count, props.shift]); } } ) ); createComputed( on( () => props.startMargin || 0, (value) => { if (value !== store.$getStartSpacerSize()) { store.$update(ACTION_START_OFFSET_CHANGE, value); } } ) ); createEffect( on(stateVersion, () => { scroller.$fixScrollJump(); }) ); return ( { const offset = createMemo(() => { stateVersion(); return store.$getItemOffset(index); }); const hide = createMemo(() => { stateVersion(); return store.$isUnmeasuredItem(index); }); return ( ); }} /> ); };