Scroll — Kuito Documentation

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.

Référence

Signatures

(props: ScrollProps): KuitoElement

Paramètres

Nom	Type	Requis	Description
`props`	`ScrollProps`	Oui	—

Retourne

KuitoElement

Props: ScrollProps

Props (props héritées incluses) 108

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

onScroll — signatures de méthode

Signatures

(event: ScrollEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`ScrollEvent`	Oui	—

Retourne

void

onScrollEnd — signatures de méthode

Signatures

(event: ScrollEndEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`ScrollEndEvent`	Oui	—

Retourne

void

onReachEnd — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`event`	`KuitoEvent<"reachend">`	Oui	—

Retourne

void

onRefresh — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`event`	`KuitoEvent<"refresh">`	Oui	—

Retourne

void

onPress — signatures de méthode

Signatures

(event: PressEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`PressEvent`	Oui	—

Retourne

void

onPressCapture — signatures de méthode

Signatures

(event: PressEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`PressEvent`	Oui	—

Retourne

void

onAction — signatures de méthode

Signatures

(event: AccessibilityActionEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`AccessibilityActionEvent`	Oui	—

Retourne

void

backgroundGradient — champs imbriqués

backgroundGradient champs

Nom	Type	Requis	Description
`angle`	`number`	Oui	—
`colors`	`string[]`	Oui	—

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.

#Read a page of paragraphs

#Behavior

#Props

#Continue

Référence

Signatures

Paramètres

Retourne

Props (props héritées incluses) 108

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

Signatures

Paramètres

Retourne

backgroundGradient champs

Read a page of paragraphs

Behavior

Props

Continue