ui/build/utils/virtualizer.svelte

Interfaces

ScrollToIndexOptions

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

Properties

align?

optional align?: ScrollAlignment;

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

behavior?

optional behavior?: ScrollBehavior;

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

---

ScrollToOffsetOptions

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

Properties

behavior?

optional behavior?: ScrollBehavior;

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

---

VirtualItem

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

Properties

end

end: number;

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

index

index: number;

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

key

key: string | number;

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

size

size: number;

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

start

start: number;

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

---

Virtualizer

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

Properties

measure

measure: () => void;

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

Drops every measured size; the next measureElement calls re-fill the cache.

Returns

void

measureElement

measureElement: (element) => void;

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

Records the size of an element carrying data-index.

Parameters

Parameter	Type
element	HTMLElement | null

Returns

void

scrollToIndex

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

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

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:23

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:21

virtualItems

readonly virtualItems: VirtualItem[];

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

---

VirtualizerOptions

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

Properties

count

count: () => number;

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

Returns

number

estimateSize

estimateSize: (index) => number;

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

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:14

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:13

listElement?

optional listElement?: () => HTMLElement | null;

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

The element the items are laid out in, when it is not the scroll content's origin.

Returns

HTMLElement | null

onChange?

optional onChange?: (virtualizer) => void;

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

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:12

scrollElement

scrollElement: () => HTMLElement | null;

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

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:36

Functions

createVirtualizer()

function createVirtualizer(options): Virtualizer;

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

Parameters

Parameter	Type
options	VirtualizerOptions

Returns

Virtualizer