Scroll — Kuito Documentação

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.

Referência

Assinaturas

(props: ScrollProps): KuitoElement

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`props`	`ScrollProps`	Sim	—

Devolve

KuitoElement

Props: ScrollProps

Props (incluindo props herdadas) 108

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

onScroll — assinaturas de método

Assinaturas

(event: ScrollEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`ScrollEvent`	Sim	—

Devolve

void

onScrollEnd — assinaturas de método

Assinaturas

(event: ScrollEndEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`ScrollEndEvent`	Sim	—

Devolve

void

onReachEnd — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`KuitoEvent<"reachend">`	Sim	—

Devolve

void

onRefresh — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`KuitoEvent<"refresh">`	Sim	—

Devolve

void

onPress — assinaturas de método

Assinaturas

(event: PressEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`PressEvent`	Sim	—

Devolve

void

onPressCapture — assinaturas de método

Assinaturas

(event: PressEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`PressEvent`	Sim	—

Devolve

void

onAction — assinaturas de método

Assinaturas

(event: AccessibilityActionEvent): void

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`AccessibilityActionEvent`	Sim	—

Devolve

void

backgroundGradient — campos aninhados

backgroundGradient campos

Nome	Tipo	Obrigatório	Descrição
`angle`	`number`	Sim	—
`colors`	`string[]`	Sim	—

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.

#Read a page of paragraphs

#Behavior

#Props

#Continue

Referência

Assinaturas

Parâmetros

Devolve

Props (incluindo props herdadas) 108

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

Assinaturas

Parâmetros

Devolve

backgroundGradient campos

Read a page of paragraphs

Behavior

Props

Continue