Skip to content

feat: add rangeExtractor prop to VirtualList #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 17, 2025
Merged

feat: add rangeExtractor prop to VirtualList #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
858171e
feat: add `rangeExtractor` prop
abdel-17 Sep 17, 2025
cc31a2c
minor refactor
abdel-17 Sep 17, 2025
d74249e
chore: add changeset
abdel-17 Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/crazy-wolves-spend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"svelte-file-tree": minor
---

feat: add `rangeExtractor` prop to `VirtualList`
3 changes: 3 additions & 0 deletions packages/svelte-file-tree/src/lib/components/VirtualList.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<script lang="ts" module>
import {
defaultRangeExtractor,
elementScroll,
observeElementOffset,
observeElementRect,
Expand Down Expand Up @@ -36,6 +37,7 @@
let {
children,
estimateSize,
rangeExtractor = defaultRangeExtractor,
overscan = 1,
paddingStart,
paddingEnd,
Expand Down Expand Up @@ -63,6 +65,7 @@
getScrollElement: () => ref,
getItemKey: (order) => visibleItems[order]!.node.id,
estimateSize: (order) => estimateSize(visibleItems[order]!, order),
rangeExtractor: (range) => rangeExtractor(range),
onChange: (instance) => {
instance._willUpdate();
treeSize = instance.getTotalSize();
Expand Down
5 changes: 4 additions & 1 deletion packages/svelte-file-tree/src/lib/components/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { ScrollToOptions } from "@tanstack/virtual-core";
import type { Range, ScrollToOptions } from "@tanstack/virtual-core";
import type { Snippet } from "svelte";
import type { HTMLAttributes } from "svelte/elements";
import type { SvelteSet } from "svelte/reactivity";
Expand Down Expand Up @@ -132,6 +132,8 @@ export type VirtualListItem<
end: number;
};

export type VirtualListRange = Range;

export type VirtualListChildrenSnippetArgs<
TFile extends FileNode = FileNode,
TFolder extends FolderNode<TFile | TFolder> = DefaultTFolder<TFile>,
Expand All @@ -146,6 +148,7 @@ export interface VirtualListProps<
> extends Omit<HTMLAttributes<HTMLDivElement>, "children"> {
children: Snippet<[args: VirtualListChildrenSnippetArgs<TFile, TFolder>]>;
estimateSize: (item: TreeItemState<TFile, TFolder>, order: number) => number;
rangeExtractor?: (range: VirtualListRange) => Array<number>;
overscan?: number;
paddingStart?: number;
paddingEnd?: number;
Expand Down