ScrollArea

A scroll container with themed scrollbars, ready for panels and lists.

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

Import

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

Usage

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

<ScrollArea orientation="both" style={{ width: 360, height: 220 }}>
  <Column gap={8} style={{ width: 720, padding: 12 }}>
    {Array.from({ length: 16 }, (_, index) => (
      <Text key={index}>Line {index + 1}: content wider than the area scrolls on both axes inside a themed scroll area.</Text>
    ))}
  </Column>
</ScrollArea>

Props

ScrollArea has no props of its own beyond the inherited and common props below.

Inherited from ViewProps 14 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—
gap number—
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 }