-
-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
186 additions
and
153 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import type { ViewportComponentAttributes } from "./types"; | ||
| import type { VirtualizerHandle, VirtualizerProps } from "./Virtualizer.type"; | ||
|
|
||
| /** | ||
| * Props of {@link VList}. | ||
| */ | ||
| export interface VListProps<T> | ||
| extends Pick< | ||
| VirtualizerProps<T>, | ||
| | "data" | ||
| | "getKey" | ||
| | "overscan" | ||
| | "itemSize" | ||
| | "shift" | ||
| | "horizontal" | ||
| | "children" | ||
| | "onscroll" | ||
| | "onscrollend" | ||
| | "onrangechange" | ||
| >, | ||
| ViewportComponentAttributes {} | ||
|
|
||
| /** | ||
| * Methods of {@link VList}. | ||
| */ | ||
| export interface VListHandle extends VirtualizerHandle {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| import { type Snippet } from "svelte"; | ||
| import type { SvelteHTMLElements } from "svelte/elements"; | ||
| import { type ScrollToIndexOpts } from "../core/types"; | ||
|
|
||
| /** | ||
| * Props of {@link Virtualizer}. | ||
| */ | ||
| export interface VirtualizerProps<T> { | ||
| /** | ||
| * The data items rendered by this component. | ||
| */ | ||
| data: T[]; | ||
| /** | ||
| * The elements renderer snippet. | ||
| */ | ||
| children: Snippet<[{ item: T; index: number }]>; | ||
| /** | ||
| * Function that returns the key of an item in the list. It's recommended to specify whenever possible for performance. | ||
| * @default defaultGetKey (returns index of item) | ||
| */ | ||
| getKey?: (data: T, index: number) => string | number; | ||
| /** | ||
| * Component or element type for container element. | ||
| * @defaultValue "div" | ||
| */ | ||
| as?: keyof SvelteHTMLElements; | ||
| /** | ||
| * Component or element type for item element. | ||
| * @defaultValue "div" | ||
| */ | ||
| item?: keyof SvelteHTMLElements; | ||
| /** | ||
| * Number of items to render above/below the visible bounds of the list. You can increase to avoid showing blank items in fast scrolling. | ||
| * @defaultValue 4 | ||
| */ | ||
| overscan?: number; | ||
| /** | ||
| * Reference to the scrollable element. The default will get the 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?: number; | ||
| /** | ||
| * 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. | ||
| */ | ||
| onscroll?: (offset: number) => void; | ||
| /** | ||
| * Callback invoked when scrolling stops. | ||
| */ | ||
| onscrollend?: () => void; | ||
| /** | ||
| * Callback invoked when visible items range changes. | ||
| */ | ||
| onrangechange?: ( | ||
| /** | ||
| * The start index of viewable items. | ||
| */ | ||
| startIndex: number, | ||
| /** | ||
| * The end index of viewable items. | ||
| */ | ||
| endIndex: number | ||
| ) => void; | ||
| } | ||
|
|
||
| /** | ||
| * Methods of {@link Virtualizer}. | ||
| */ | ||
| export interface VirtualizerHandle { | ||
| /** | ||
| * Get current scrollTop or scrollLeft. | ||
| */ | ||
| getScrollOffset: () => number; | ||
| /** | ||
| * Get current scrollHeight or scrollWidth. | ||
| */ | ||
| getScrollSize: () => number; | ||
| /** | ||
| * Get current offsetHeight or offsetWidth. | ||
| */ | ||
| getViewportSize: () => 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; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.