chore: follow the general comments style
This commit is contained in:
@@ -45,7 +45,9 @@ export interface VirtualItem {
|
||||
* Options are reactive - pass them through a function getter to enable updates.
|
||||
*/
|
||||
export interface VirtualizerOptions {
|
||||
/** Total number of items in the data array */
|
||||
/**
|
||||
* Total number of items in the underlying data array
|
||||
*/
|
||||
count: number;
|
||||
/**
|
||||
* Function to estimate the size of an item at a given index.
|
||||
@@ -60,7 +62,10 @@ export interface VirtualizerOptions {
|
||||
* as fonts finish loading, eliminating the DOM-measurement snap on load.
|
||||
*/
|
||||
estimateSize: (index: number) => number;
|
||||
/** Number of extra items to render outside viewport for smoother scrolling (default: 5) */
|
||||
/**
|
||||
* Number of extra items to render outside viewport for smoother scrolling
|
||||
* @default 5
|
||||
*/
|
||||
overscan?: number;
|
||||
/**
|
||||
* Function to get the key of an item at a given index.
|
||||
@@ -464,27 +469,45 @@ export function createVirtualizer<T>(
|
||||
}
|
||||
|
||||
return {
|
||||
/**
|
||||
* Current vertical scroll position in pixels (reactive)
|
||||
*/
|
||||
get scrollOffset() {
|
||||
return scrollOffset;
|
||||
},
|
||||
/**
|
||||
* Measured height of the visible container area (reactive)
|
||||
*/
|
||||
get containerHeight() {
|
||||
return containerHeight;
|
||||
},
|
||||
/** Computed array of visible items to render (reactive) */
|
||||
/**
|
||||
* Computed array of visible items to render (reactive)
|
||||
*/
|
||||
get items() {
|
||||
return items;
|
||||
},
|
||||
/** Total height of all items in pixels (reactive) */
|
||||
/**
|
||||
* Total height of all items in pixels (reactive)
|
||||
*/
|
||||
get totalSize() {
|
||||
return totalSize;
|
||||
},
|
||||
/** Svelte action for the scrollable container element */
|
||||
/**
|
||||
* Svelte action for the scrollable container element
|
||||
*/
|
||||
container,
|
||||
/** Svelte action for measuring individual item elements */
|
||||
/**
|
||||
* Svelte action for measuring individual item elements
|
||||
*/
|
||||
measureElement,
|
||||
/** Programmatic scroll method to scroll to a specific item */
|
||||
/**
|
||||
* Programmatic scroll method to scroll to a specific item
|
||||
*/
|
||||
scrollToIndex,
|
||||
/** Programmatic scroll method to scroll to a specific pixel offset */
|
||||
/**
|
||||
* Programmatic scroll method to scroll to a specific pixel offset
|
||||
*/
|
||||
scrollToOffset,
|
||||
};
|
||||
}
|
||||
|
||||
@@ -1,4 +1,6 @@
|
||||
/** @vitest-environment jsdom */
|
||||
/**
|
||||
* @vitest-environment jsdom
|
||||
*/
|
||||
import {
|
||||
afterEach,
|
||||
describe,
|
||||
|
||||
Reference in New Issue
Block a user