Scroll — Kuito Dokumentation

Scroll a page whose children can all stay mounted. Use it for an article, form or a small set of sections.

Read a page of paragraphs

tsx

import { Scroll, Text } from 'kuito';

const paragraphs = ['The tide came in.', 'It went out again.', 'Nobody noticed.'];

export default function Article() {
  return (
    <Scroll flex={1} padding={16} gap={12}>
      {paragraphs.map((paragraph) => (
        <Text key={paragraph}>{paragraph}</Text>
      ))}
    </Scroll>
  );
}

Behavior

Give the scroll view a bounded height, often with flex={1}. All children are rendered. Use List for large collections. Vertical scroll views can keep focused fields clear of the keyboard.

Props

Prop	Meaning
`horizontal`	Scroll sideways. Changing it remounts the view.
`onScroll`, `scrollInterval`	`{ x, y, contentWidth, contentHeight, layoutWidth, layoutHeight }` in points, at most once per throttle (50 ms by default).
`onScrollEnd`	HTML's `scrollend`: the same fields, where it came to rest after a fling, a drag or a `scrollTo`, once per rest.
`onReachEnd`, `reachEndThreshold`	Once each time the end comes within the threshold, in visible lengths (0.5 by default).
`onRefresh`, `refreshing`	Pull-to-refresh (vertical only).
`scrollbar`	Shows or hides the scrollbar.
`motion`	`scrollMotion()`: its `offset`, `velocity` and `overscroll` move with the view every frame, on the UI thread (follow scrolling).
`paging`, `snapOffsets`	Where a drag comes to rest: whole pages, or the offsets given.
`keyboard`	`{ dismiss, persistTaps, inset, avoid }`: when dragging dismisses the keyboard, what a tap outside the field does, whether content stays clear of it (true by default) (keyboard).

Continue

Read Keyboard for a complete workflow. See the complete prop reference for types and documented defaults.

Referenz

Signaturen

(props: ScrollProps): KuitoElement

Parameter

Name	Typ	Erforderlich	Beschreibung
`props`	`ScrollProps`	Ja	—

Rückgabe

KuitoElement

Props: ScrollProps

Props (einschließlich geerbter Props) 108

Name	Typ	Erforderlich	Beschreibung
`horizontal`	`Prop<boolean>`	Nein	Scrolls sideways; changing it remounts the view, as the native axis is fixed.
`ref`	`ElementRef<ScrollHandle>`	Nein	—
`motion`	`ScrollMotion`	Nein	Moves with the view every frame on the UI thread: `scrollMotion()`, given to one view.
`onScroll`	`(event: ScrollEvent) => void`	Nein	—
`onScrollEnd`	`(event: ScrollEndEvent) => void`	Nein	Where it came to rest: after a fling, a drag or a `scrollTo`, once per rest.
`onReachEnd`	`(event: KuitoEvent<"reachend">) => void`	Nein	Called once each time the content end comes within the threshold.
`onRefresh`	`(event: KuitoEvent<"refresh">) => void`	Nein	Enables pull-to-refresh.
`opacity`	`Animatable<number>`	Nein	—
`backgroundColor`	`Animatable<string>`	Nein	—
`borderRadius`	`Animatable<number>`	Nein	—
`borderColor`	`Animatable<string>`	Nein	—
`width`	`Animatable<SizeValue>`	Nein	—
`height`	`Animatable<SizeValue>`	Nein	—
`translateX`	`Animatable<number>`	Nein	—
`translateY`	`Animatable<number>`	Nein	—
`scale`	`Animatable<number>`	Nein	—
`scaleX`	`Animatable<number>`	Nein	—
`scaleY`	`Animatable<number>`	Nein	—
`rotate`	`Animatable<number>`	Nein	Degrees.
`shadowColor`	`Animatable<string>`	Nein	—
`shadowRadius`	`Animatable<number>`	Nein	—
`shadowOffsetX`	`Animatable<number>`	Nein	—
`shadowOffsetY`	`Animatable<number>`	Nein	—
`hidden`	`Prop<boolean>`	Nein	Takes the view out of layout and off screen, as CSS `display: none`.
`padding`	`Prop<LengthPercentage>`	Nein	—
`position`	`Prop<"relative" \| "absolute">`	Nein	—
`children`	`KuitoNode`	Nein	—
`id`	`string`	Nein	—
`class`	`Prop<ClassNames>`	Nein	Class names from a .css import or styles(): a string, or a list with falsy entries skipped, following the signals it reads.
`style`	`StyleDeclarations`	Nein	Styles of this view alone, compiled at build time: CSS properties in camelCase. A value that changes must set a native prop (`opacity`).
`onPress`	`(event: PressEvent) => void`	Nein	—
`onPressCapture`	`(event: PressEvent) => void`	Nein	—
`key`	`string \| number`	Nein	—
`paddingTop`	`Prop<LengthPercentage>`	Nein	—
`paddingRight`	`Prop<LengthPercentage>`	Nein	—
`paddingBottom`	`Prop<LengthPercentage>`	Nein	—
`paddingLeft`	`Prop<LengthPercentage>`	Nein	—
`minWidth`	`Prop<SizeValue>`	Nein	—
`maxWidth`	`Prop<SizeValue>`	Nein	—
`minHeight`	`Prop<SizeValue>`	Nein	—
`maxHeight`	`Prop<SizeValue>`	Nein	—
`aspectRatio`	`Prop<number>`	Nein	Width divided by height; sizes the missing side from the other.
`top`	`Prop<LengthPercentageAuto>`	Nein	—
`right`	`Prop<LengthPercentageAuto>`	Nein	—
`bottom`	`Prop<LengthPercentageAuto>`	Nein	—
`left`	`Prop<LengthPercentageAuto>`	Nein	—
`margin`	`Prop<LengthPercentageAuto>`	Nein	—
`marginTop`	`Prop<LengthPercentageAuto>`	Nein	—
`marginRight`	`Prop<LengthPercentageAuto>`	Nein	—
`marginBottom`	`Prop<LengthPercentageAuto>`	Nein	—
`marginLeft`	`Prop<LengthPercentageAuto>`	Nein	—
`flexGrow`	`Prop<number>`	Nein	—
`flexShrink`	`Prop<number>`	Nein	—
`flexBasis`	`Prop<SizeValue \| "content">`	Nein	—
`flex`	`Prop<number>`	Nein	A grow factor from a zero basis, as CSS `flex: n`; 0 is inflexible.
`alignSelf`	`Prop<"auto" \| SelfAlignment>`	Nein	—
`direction`	`Prop<"ltr" \| "rtl">`	Nein	The way lines run; unset, the parent's, and the app's first language's at the root.
`boxSizing`	`Prop<"border-box" \| "content-box">`	Nein	—
`paddingInlineStart`	`Prop<LengthPercentage>`	Nein	Padding on the side lines start from: the left in `ltr`, the right in `rtl`.
`paddingInlineEnd`	`Prop<LengthPercentage>`	Nein	Padding on the side lines end at: the right in `ltr`, the left in `rtl`.
`marginInlineStart`	`Prop<LengthPercentageAuto>`	Nein	Margin on the side lines start from: the left in `ltr`, the right in `rtl`.
`marginInlineEnd`	`Prop<LengthPercentageAuto>`	Nein	Margin on the side lines end at: the right in `ltr`, the left in `rtl`.
`insetInlineStart`	`Prop<LengthPercentageAuto>`	Nein	`left` in `ltr`, `right` in `rtl`.
`insetInlineEnd`	`Prop<LengthPercentageAuto>`	Nein	`right` in `ltr`, `left` in `rtl`.
`role`	`Prop<Role>`	Nein	—
`onAction`	`(event: AccessibilityActionEvent) => void`	Nein	The screen reader action taken, by `name`.
`accessible`	`Prop<boolean>`	Nein	Makes the view one screen reader element, read as its label or its children's text.
`label`	`Prop<string>`	Nein	What a screen reader says for the view.
`hint`	`Prop<string>`	Nein	What happens when the view is activated, read after the label.
`aria-hidden`	`Prop<boolean>`	Nein	Screen readers skip the view and its subtree.
`actions`	`Prop<readonly AccessibilityAction[]>`	Nein	Actions a screen reader offers; `onAction` receives the one taken.
`live`	`Prop<"off" \| "polite" \| "assertive">`	Nein	ARIA's `aria-live`: announces changes to the view's content, on iOS too.
`aria-disabled`	`Prop<boolean>`	Nein	—
`aria-selected`	`Prop<boolean>`	Nein	—
`aria-checked`	`Prop<boolean \| "mixed">`	Nein	—
`aria-busy`	`Prop<boolean>`	Nein	—
`aria-expanded`	`Prop<boolean>`	Nein	—
`aria-valuemin`	`Prop<number>`	Nein	—
`aria-valuemax`	`Prop<number>`	Nein	—
`aria-valuenow`	`Prop<number>`	Nein	—
`aria-valuetext`	`Prop<string>`	Nein	—
`gestures`	`readonly Composable[]`	Nein	The view's gestures; several race unless composed with together or orElse.
`transition`	`Partial<Record<"opacity" \| "backgroundColor" \| "transform" \| "borderRadius" \| "borderColor" \| "shadow" \| "width" \| "height" \| "all", Animation<unknown> \| AnimationSpec>>`	Nein	How the animatable props move when they change, enter or leave, by group; a CSS `transition` compiles to it.
`animate`	`Partial<Record<AnimatableProps, string \| number>>`	Nein	Animatable props whose every change moves as `transition` says; the first value applies at once.
`enter`	`Effect`	Nein	Where the view enters from: `fade.and(slide.up(12))`.
`exit`	`Prop<Effect>`	Nein	Where the view leaves to; it stays on screen until it is there. The renderer gets `true`, and keeps the view until `exited`.
`layout`	`Animation<number>`	Nein	How the view moves to a new frame the layout gives it: `layout={spring()}`.
`overflow`	`Prop<"visible" \| "hidden" \| "clip" \| "scroll">`	Nein	hidden and scroll clip; as in CSS, either lets a flex item shrink below its content.
`borderWidth`	`Prop<number>`	Nein	—
`backgroundGradient`	`{ angle: number; colors: string[];}`	Nein	—
`color`	`Prop<string>`	Nein	—
`sharedId`	`Prop<string>`	Nein	A view the navigation stack flies to the view with the same sharedId on the screen it pushes or pops to (docs/navigation.md#shared-elements).
`alignItems`	`Prop<SelfAlignment>`	Nein	—
`justifyContent`	`Prop<ContentAlignment>`	Nein	—
`gap`	`Prop<LengthPercentage>`	Nein	—
`rowGap`	`Prop<LengthPercentage>`	Nein	—
`columnGap`	`Prop<LengthPercentage>`	Nein	—
`flexDirection`	`Prop<"row" \| "column" \| "row-reverse" \| "column-reverse">`	Nein	—
`flexWrap`	`Prop<"nowrap" \| "wrap" \| "wrap-reverse" \| "balance">`	Nein	—
`flexLineCount`	`Prop<number>`	Nein	The minimum number of lines a wrapping container breaks into (CSS Flexbox 2).
`alignContent`	`Prop<ContentAlignment>`	Nein	—
`scrollInterval`	`Prop<number>`	Nein	At most one scroll event per this many milliseconds; 50 by default.
`reachEndThreshold`	`Prop<number>`	Nein	Distance from the end, in visible lengths, that counts as the end; 0.5 by default.
`refreshing`	`Bound<boolean>`	Nein	Shows the pull-to-refresh spinner while true.
`scrollbar`	`Prop<boolean>`	Nein	Shows the scrollbar while scrolling; true by default.
`paging`	`Prop<boolean>`	Nein	Comes to rest a whole view length at a time; false by default.
`snapOffsets`	`Prop<readonly number[]>`	Nein	Offsets in points where a drag comes to rest, besides the start and the end; ignored while paging.
`keyboard`	`Prop<{ dismiss?: "none" \| "on-drag" \| "interactive"; persistTaps?: "never" \| "always" \| "handled"; inset?: boolean; avoid?: "none" \| "padding" \| "position";}>`	Nein	—

onScroll — Methodensignaturen

Signaturen

(event: ScrollEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`ScrollEvent`	Ja	—

Rückgabe

void

onScrollEnd — Methodensignaturen

Signaturen

(event: ScrollEndEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`ScrollEndEvent`	Ja	—

Rückgabe

void

onReachEnd — Methodensignaturen

Signaturen

(event: KuitoEvent<"reachend">): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`KuitoEvent<"reachend">`	Ja	—

Rückgabe

void

onRefresh — Methodensignaturen

Signaturen

(event: KuitoEvent<"refresh">): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`KuitoEvent<"refresh">`	Ja	—

Rückgabe

void

onPress — Methodensignaturen

Signaturen

(event: PressEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`PressEvent`	Ja	—

Rückgabe

void

onPressCapture — Methodensignaturen

Signaturen

(event: PressEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`PressEvent`	Ja	—

Rückgabe

void

onAction — Methodensignaturen

Signaturen

(event: AccessibilityActionEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`AccessibilityActionEvent`	Ja	—

Rückgabe

void

backgroundGradient — verschachtelte Felder

backgroundGradient Felder

Name	Typ	Erforderlich	Beschreibung
`angle`	`number`	Ja	—
`colors`	`string[]`	Ja	—

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.

#Read a page of paragraphs

#Behavior

#Props

#Continue

Referenz

Signaturen

Parameter

Rückgabe

Props (einschließlich geerbter Props) 108

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

backgroundGradient Felder

Read a page of paragraphs

Behavior

Props

Continue