ui/build/utils/virtualizer.svelte

Interfaces

ScrollToIndexOptions

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:36

Properties

align?

optional align?: ScrollAlignment;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:37

behavior?

optional behavior?: ScrollBehavior;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:38

---

ScrollToOffsetOptions

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:40

Properties

behavior?

optional behavior?: ScrollBehavior;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:41

---

VirtualItem

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:6

Svelte 5 Runes-based Virtualizer

A lightweight virtualizer using runed primitives and small inlined helpers (e.g. sorted-index binary search).

Properties

end

end: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:10

index

index: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:7

key

key: string | number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:8

size

size: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:11

start

start: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:9

---

Virtualizer

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:24

Properties

getOffsetForIndex

getOffsetForIndex: (index, align?) => number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:32

Parameters

Parameter	Type
index	number
align?	ScrollAlignment

Returns

number

getTotalSize

getTotalSize: () => number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:34

Returns

number

getVirtualItems

getVirtualItems: () => VirtualItem[];

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:33

Returns

VirtualItem[]

measure

measure: () => void;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:30

Returns

void

measureElement

measureElement: (element) => void;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:31

Parameters

Parameter	Type
element	HTMLElement | null

Returns

void

scrollOffset

readonly scrollOffset: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:27

scrollToIndex

scrollToIndex: (index, options?) => void;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:28

Parameters

Parameter	Type
index	number
options?	ScrollToIndexOptions

Returns

void

scrollToOffset

scrollToOffset: (offset, options?) => void;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:29

Parameters

Parameter	Type
offset	number
options?	ScrollToOffsetOptions

Returns

void

totalSize

readonly totalSize: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:26

virtualItems

readonly virtualItems: VirtualItem[];

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:25

---

VirtualizerOptions

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:13

Properties

count

count: () => number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:14

Returns

number

estimateSize

estimateSize: (index) => number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:16

Parameters

Parameter	Type
index	number

Returns

number

getItemKey?

optional getItemKey?: (index) => string | number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:19

Parameters

Parameter	Type
index	number

Returns

string | number

horizontal?

optional horizontal?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:18

indexAttribute?

optional indexAttribute?: string;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:22

initialOffset?

optional initialOffset?: number;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:21

onChange?

optional onChange?: (virtualizer) => void;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:20

Parameters

Parameter	Type
virtualizer	Virtualizer

Returns

void

overscan?

optional overscan?: number | (() => number);

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:17

scrollElement

scrollElement: () => HTMLElement | null;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:15

Returns

HTMLElement | null

Type Aliases

ScrollAlignment

type ScrollAlignment = "start" | "center" | "end" | "auto";

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:43

Functions

createVirtualizer()

function createVirtualizer(options): Virtualizer;

Defined in: apps/website/.api-docs-entry/ui/build/utils/virtualizer.svelte.d.ts:44

Parameters

Parameter	Type
options	VirtualizerOptions

Returns

Virtualizer