List

A simple, non-virtual list where every item stays mounted.

A regular, non-virtual list. Every item stays mounted and can have any height.

List rendered by Tarve List rendered by Tarve
Native render. The live version loads when this comes into view.

Import

import { List } from "@tarve/core";

Usage

List.tsx
import { List, Text } from "@tarve/core";

const tasks = ["Write docs", "Ship v0.4", "Celebrate"];

<List
  items={tasks}
  gap={8}
  keyForItem={(task) => task}
  renderItem={(task, index) => <Text>{index + 1}. {task}</Text>}
/>

Props

PropTypeDefault
gap number0
items readonly T[]—
keyForItem (item: T, index: number) => string | number—
renderItem (item: T, index: number) => Child—
Inherited from ViewProps 13 props
PropTypeDefault
align Style["align"]—
autoFocus

Focus this control when it first appears (HTML `autofocus`); interactive views only (Pressable).

boolean—
children BindableChild—
dismissOnOutside

A press outside the box fires `onOutsideClick` instead of reaching what is under it (light dismiss). Works on portals and in-flow boxes; an open portal wins.

boolean—
dragRegion boolean—
flex

CSS `flex`: `1` is `1 1 0`; strings take any CSS value, e.g. `"1 1 176px"`.

number | string—
focusable boolean—
justify Style["justify"]—
onOutsideClick

With `dismissOnOutside`: a press (or right click) outside the box.

() => void—
padding Style["padding"]—
portal boolean—
style

Values may be signals: setting one restyles this box without a render.

Reactive<Style>—
windowAction "minimize" | "toggleMaximize" | "toggleFullscreen" | "close"—
Inherited from ScrollProps 5 props
PropTypeDefault
followTail

Stick to the end: while the area is at its end (or new), growing content keeps it there (a chat, a log). Scrolling away stops it; scrolling back to the end resumes it.

boolean—
onScroll (offset: number, max: number, info: ScrollInfo) => void—
onScrollPosition (position: ScrollPosition) => void—
orientation ScrollOrientation—
speed number—

Common props

Shared by every component. See descriptions →

classclassNamedropTargetfileDropTargethighlightidkeymotionFromonDragEnteronDragLeaveonDroponFileDragEnteronFileDragLeaveonFileDroponHighlightonPasteonPointerLeaveonPointerMoveonSizeonTransitionEndrovingGroup

Types

BindableChild
type BindableChild = Child | Signal<unknown> | BindableChild[];
Reactive
type Reactive<S> = { [K in keyof S]: S[K] | Signal<Exclude<S[K], undefined>> };
ScrollInfo
interface ScrollInfo { source: ScrollSource }
ScrollOrientation
type ScrollOrientation = "vertical" | "horizontal" | "both";
ScrollPosition
interface ScrollPosition { x: number; y: number; maxX: number; maxY: number; source: ScrollSource }