CreateListViewOptions

Defined in: ui/widgets/list-view.ts:148

Type Parameters

T

T

Properties

background?

optional background?: UIVisualInit

Defined in: ui/widgets/list-view.ts:158

Viewport background. Default: a transparent hit-target (so the wheel works).

---

data

data: DataSource<T> | readonly T[]

Defined in: ui/widgets/list-view.ts:160

Backing data — a DataSource<T> or a raw array (wrapped in an ArrayDataSource).

---

decelerationRate?

optional decelerationRate?: number

Defined in: ui/widgets/list-view.ts:174

Fling velocity fraction left after 1s of coasting. Default 0.135.

---

direction?

optional direction?: "horizontal" | "vertical" | "both"

Defined in: ui/widgets/list-view.ts:166

Scroll axis. Defaults from the layout (column→vertical, row→horizontal).

---

dragScroll?

optional dragScroll?: boolean

Defined in: ui/widgets/list-view.ts:172

Drag/touch scrolling with a kinetic fling. Default true.

---

host

host: ListViewHost

Defined in: ui/widgets/list-view.ts:151

The plugin that ticks virtualization + routes scroll input (uiPlugin).

---

item

item: ListItemTemplate<T> | Record<string, ListItemTemplate<T>>

Defined in: ui/widgets/list-view.ts:164

One template, or a map of item type → template for heterogeneous rows.

---

layout

layout: LayoutProvider | ListLayoutSpec

Defined in: ui/widgets/list-view.ts:162

Layout sugar (itemHeight / columns …) or a full LayoutProvider.

---

node?

optional node?: UINodeInit

Defined in: ui/widgets/list-view.ts:156

Extra viewport UINode props (its size defaults to viewportSize).

---

onItemBound?

optional onItemBound?: (entity, data, index) => void

Defined in: ui/widgets/list-view.ts:176

Called after each item bind.

Parameters

entity

number

data

T

index

number

Returns

void

---

parent?

optional parent?: number

Defined in: ui/widgets/list-view.ts:152

---

recycleBuffer?

optional recycleBuffer?: number

Defined in: ui/widgets/list-view.ts:168

Extra indices kept mounted on each side of the visible range. Default 2.

---

viewportSize

viewportSize: Vec2

Defined in: ui/widgets/list-view.ts:154

Initial UI layout size; virtualization and scroll bounds follow the resolved box.

---

wheelSpeed?

optional wheelSpeed?: number

Defined in: ui/widgets/list-view.ts:170

Wheel delta multiplier. Default 1.

---

world

world: World

Defined in: ui/widgets/list-view.ts:149