virtua 0.36.1 → 0.36.2

package/lib/react/Virtualizer.d.ts

@@ -10,15 +10,15 @@ export interface VirtualizerHandle {
      */
     readonly cache: CacheSnapshot;
     /**
-     * Get current scrollTop or scrollLeft.
+     * Get current scrollTop, or scrollLeft if horizontal: true.
      */
     readonly scrollOffset: number;
     /**
-     * Get current scrollHeight or scrollWidth.
+     * Get current scrollHeight, or scrollWidth if horizontal: true.
      */
     readonly scrollSize: number;
     /**
-     * Get current offsetHeight or offsetWidth.
+     * Get current offsetHeight, or offsetWidth if horizontal: true.
      */
     readonly viewportSize: number;
     /**
@@ -106,12 +106,12 @@ export interface VirtualizerProps {
      */
     item?: keyof JSX.IntrinsicElements | CustomItemComponent;
     /**
-     * Reference to the scrollable element. The default will get the parent element of virtualizer.
+     * Reference to the scrollable element. The default will get the direct parent element of virtualizer.
      */
     scrollRef?: RefObject<HTMLElement>;
     /**
      * Callback invoked whenever scroll offset changes.
-     * @param offset Current scrollTop or scrollLeft.
+     * @param offset Current scrollTop, or scrollLeft if horizontal: true.
      */
     onScroll?: (offset: number) => void;
     /**
@@ -120,16 +120,10 @@ export interface VirtualizerProps {
     onScrollEnd?: () => void;
     /**
      * Callback invoked when visible items range changes.
+     * @param startIndex The start index of viewable items.
+     * @param endIndex The end index of viewable items.
      */
-    onRangeChange?: (
-    /**
-     * The start index of viewable items.
-     */
-    startIndex: number, 
-    /**
-     * The end index of viewable items.
-     */
-    endIndex: number) => void;
+    onRangeChange?: (startIndex: number, endIndex: number) => void;
 }
 /**
  * Customizable list virtualizer for advanced usage. See {@link VirtualizerProps} and {@link VirtualizerHandle}.

package/lib/react/WindowVirtualizer.d.ts

@@ -70,16 +70,10 @@ export interface WindowVirtualizerProps {
     onScrollEnd?: () => void;
     /**
      * Callback invoked when visible items range changes.
+     * @param startIndex The start index of viewable items.
+     * @param endIndex The end index of viewable items.
      */
-    onRangeChange?: (
-    /**
-     * The start index of viewable items.
-     */
-    startIndex: number, 
-    /**
-     * The end index of viewable items.
-     */
-    endIndex: number) => void;
+    onRangeChange?: (startIndex: number, endIndex: number) => void;
 }
 /**
  * {@link Virtualizer} controlled by the window scrolling. See {@link WindowVirtualizerProps} and {@link WindowVirtualizerHandle}.

package/lib/solid/Virtualizer.d.ts

@@ -8,15 +8,15 @@ import { ScrollToIndexOpts } from "../core/types";
  */
 export interface VirtualizerHandle {
     /**
-     * Get current scrollTop or scrollLeft.
+     * Get current scrollTop, or scrollLeft if horizontal: true.
      */
     readonly scrollOffset: number;
     /**
-     * Get current scrollHeight or scrollWidth.
+     * Get current scrollHeight, or scrollWidth if horizontal: true.
      */
     readonly scrollSize: number;
     /**
-     * Get current offsetHeight or offsetWidth.
+     * Get current offsetHeight, or offsetWidth if horizontal: true.
      */
     readonly viewportSize: number;
     /**
@@ -73,7 +73,7 @@ export interface VirtualizerProps<T> {
      */
     item?: ValidComponent;
     /**
-     * Reference to the scrollable element. The default will get the parent element of virtualizer.
+     * Reference to the scrollable element. The default will get the direct parent element of virtualizer.
      */
     scrollRef?: HTMLElement;
     /**
@@ -97,7 +97,7 @@ export interface VirtualizerProps<T> {
     startMargin?: number;
     /**
      * Callback invoked whenever scroll offset changes.
-     * @param offset Current scrollTop or scrollLeft.
+     * @param offset Current scrollTop, or scrollLeft if horizontal: true.
      */
     onScroll?: (offset: number) => void;
     /**
@@ -106,16 +106,10 @@ export interface VirtualizerProps<T> {
     onScrollEnd?: () => void;
     /**
      * Callback invoked when visible items range changes.
+     * @param startIndex The start index of viewable items.
+     * @param endIndex The end index of viewable items.
      */
-    onRangeChange?: (
-    /**
-     * The start index of viewable items.
-     */
-    startIndex: number, 
-    /**
-     * The end index of viewable items.
-     */
-    endIndex: number) => void;
+    onRangeChange?: (startIndex: number, endIndex: number) => void;
 }
 /**
  * Customizable list virtualizer for advanced usage. See {@link VirtualizerProps} and {@link VirtualizerHandle}.

package/lib/solid/WindowVirtualizer.d.ts

@@ -40,16 +40,10 @@ export interface WindowVirtualizerProps<T> {
     onScrollEnd?: () => void;
     /**
      * Callback invoked when visible items range changes.
+     * @param startIndex The start index of viewable items.
+     * @param endIndex The end index of viewable items.
      */
-    onRangeChange?: (
-    /**
-     * The start index of viewable items.
-     */
-    startIndex: number, 
-    /**
-     * The end index of viewable items.
-     */
-    endIndex: number) => void;
+    onRangeChange?: (startIndex: number, endIndex: number) => void;
 }
 /**
  * {@link Virtualizer} controlled by the window scrolling. See {@link WindowVirtualizerProps} and {@link WindowVirtualizerHandle}.