ScrollViewProps

Defined in: ui/src/types.ts:500

Props for ScrollViewNode / <ScrollView>.

The viewport box is sized via the inherited LayoutProps (width / height / flexGrow …). Content overflowing the scroll axis is clipped and pannable. gap / padding apply to the inner content stack.

Extends

• LayoutProps.ConsumeInputProps

Properties

alignSelf?

optional alignSelf?: "stretch" | "auto" | "flex-start" | "center" | "flex-end" | "baseline"

Defined in: ui/src/types.ts:137

Inherited from

LayoutProps.alignSelf

---

background?

optional background?: BackgroundOptions

Defined in: ui/src/types.ts:515

Background drawn behind the clipped content.

---

bottom?

optional bottom?: PositionValue

Defined in: ui/src/types.ts:163

Offset from the containing block’s bottom edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.bottom

---

consumeInput?

optional consumeInput?: boolean

Defined in: ui/src/types.ts:209

Inherited from

ConsumeInputProps.consumeInput

---

direction?

optional direction?: "horizontal" | "vertical"

Defined in: ui/src/types.ts:502

Scroll/stack axis. Default "vertical".

---

flex?

optional flex?: number

Defined in: ui/src/types.ts:136

Shorthand for the common CSS flex: <number> case — expands to flexGrow: <number>, flexShrink: 1, flexBasis: 0. Use it for a child that should fill the remaining main-axis space (e.g. the text column between a fixed icon and a fixed button): sizing from a 0 basis means it won’t claim its content width and push its siblings, and its text wraps cleanly. Prefer this over flexGrow: 1 alone, which keeps flexBasis: auto (content width) and overflows. Explicit flexGrow/flexShrink/flexBasis override the parts this expands to.

Inherited from

LayoutProps.flex

---

flexBasis?

optional flexBasis?: LayoutValue

Defined in: ui/src/types.ts:125

Inherited from

LayoutProps.flexBasis

---

flexGrow?

optional flexGrow?: number

Defined in: ui/src/types.ts:123

Inherited from

LayoutProps.flexGrow

---

flexShrink?

optional flexShrink?: number

Defined in: ui/src/types.ts:124

Inherited from

LayoutProps.flexShrink

---

gap?

optional gap?: number

Defined in: ui/src/types.ts:504

Gap between child cards (forwarded to the content stack).

---

height?

optional height?: LayoutValue

Defined in: ui/src/types.ts:115

Inherited from

LayoutProps.height

---

left?

optional left?: PositionValue

Defined in: ui/src/types.ts:157

Offset from the containing block’s left edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.left

---

margin?

optional margin?: number | { bottom?: number; left?: number; right?: number; top?: number; }

Defined in: ui/src/types.ts:120

Inherited from

LayoutProps.margin

---

maxHeight?

optional maxHeight?: LayoutValue

Defined in: ui/src/types.ts:119

Inherited from

LayoutProps.maxHeight

---

maxWidth?

optional maxWidth?: LayoutValue

Defined in: ui/src/types.ts:117

Inherited from

LayoutProps.maxWidth

---

minHeight?

optional minHeight?: LayoutValue

Defined in: ui/src/types.ts:118

Inherited from

LayoutProps.minHeight

---

minWidth?

optional minWidth?: LayoutValue

Defined in: ui/src/types.ts:116

Inherited from

LayoutProps.minWidth

---

onScroll?

optional onScroll?: (offset) => void

Defined in: ui/src/types.ts:517

Called when the scroll offset changes.

Parameters

offset

number

Returns

void

---

padding?

optional padding?: Padding

Defined in: ui/src/types.ts:506

Padding inside the content stack.

---

position?

optional position?: "relative" | "absolute"

Defined in: ui/src/types.ts:155

Positioning mode for this element relative to its parent. Defaults to "relative" — the element flows in the parent’s flex layout. Set to "absolute" to lift the element out of the flow and pin it via left / top / right / bottom against the parent’s content box.

A position: "relative" ancestor acts as the containing block for any absolute-positioned descendants — useful for HUD overlays, modal backdrops, and badge markers. See <ZStack> in @yagejs/ui-react for an opinionated overlay primitive.

Inherited from

LayoutProps.position

---

right?

optional right?: PositionValue

Defined in: ui/src/types.ts:161

Offset from the containing block’s right edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.right

---

scrollbar?

optional scrollbar?: boolean | ScrollbarOptions

Defined in: ui/src/types.ts:513

Scrollbar thumb. true (default) / omitted → default style; false → hidden (and no gutter reserved); an object → custom size / style. When shown, a gutter equal to the thumb’s footprint is reserved on the scroll-cross edge so content never renders under the thumb.

---

top?

optional top?: PositionValue

Defined in: ui/src/types.ts:159

Offset from the containing block’s top edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.top

---

visible?

optional visible?: boolean

Defined in: ui/src/types.ts:164

Inherited from

LayoutProps.visible

---

width?

optional width?: LayoutValue

Defined in: ui/src/types.ts:114

Inherited from

LayoutProps.width