Display a bundled, remote or local-file image. Use it for avatars, covers and photos returned by the picker or camera.

Load a cover without a blank flash

tsx
import { Image } from 'kuito';

export default function Cover() {
  return (
    <Image
      src="https://example.com/cover.jpg"
      width={160}
      aspectRatio={1}
      borderRadius={8}
      placeholder="#1e293b"
      fadeDuration={250}
    />
  );
}

Behavior

Give the image dimensions or an aspect ratio so layout can reserve space before download. placeholder fills the waiting area and fadeDuration controls its reveal. Remote images use native caching; image.prefetch warms the cache.

Props

Prop Meaning
src A URL string, { uri, headers? }, or an imported image (assets).
objectFit CSS's object-fit: cover (default), contain, fill or none.
tintColor Recolors opaque pixels, for icons.
onLoadStart / onLoadEnd Around every load, success or failure.
onLoad { width, height } of the image in pixels.
onError { error }, e.g. "HTTP 404".
aspectRatio (Kuito) Width ÷ height: sizes the view before the image arrives.
placeholder (Kuito) Color shown while loading.
thumbhash (Kuito) A base64 ThumbHash: its blurred preview shows while loading, over placeholder.
fadeDuration (Kuito) Cross-fade in milliseconds when the image appears; 0 by default.
cache (Kuito) memory-disk (default), memory, disk or none.

Continue

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

Referência

Assinaturas

ts
(props: ImageProps): KuitoElement

Parâmetros

NomeTipoObrigatórioDescrição
propsImagePropsSim—

Devolve

KuitoElement

Props: ImageProps

Props (incluindo props herdadas) 96

NomeTipoObrigatórioDescrição
onLoadStart(event: KuitoEvent<"loadstart">) => voidNão—
onLoad(event: ImageLoadEvent) => voidNão—
onError(event: ImageErrorEvent) => voidNão—
onLoadEnd(event: KuitoEvent<"loadend">) => voidNão—
idstringNão—
refElementRef<ElementHandle>Não—
classProp<ClassNames>NãoClass names from a .css import or styles(): a string, or a list with falsy entries skipped, following the signals it reads.
styleStyleDeclarationsNãoStyles 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) => voidNão—
onPressCapture(event: PressEvent) => voidNão—
keystring | numberNão—
hiddenProp<boolean>NãoTakes the view out of layout and off screen, as CSS display: none.
paddingProp<LengthPercentage>Não—
paddingTopProp<LengthPercentage>Não—
paddingRightProp<LengthPercentage>Não—
paddingBottomProp<LengthPercentage>Não—
paddingLeftProp<LengthPercentage>Não—
widthAnimatable<SizeValue>Não—
heightAnimatable<SizeValue>Não—
minWidthProp<SizeValue>Não—
maxWidthProp<SizeValue>Não—
minHeightProp<SizeValue>Não—
maxHeightProp<SizeValue>Não—
aspectRatioProp<number>NãoWidth divided by height; sizes the missing side from the other.
positionProp<"relative" | "absolute">Não—
topProp<LengthPercentageAuto>Não—
rightProp<LengthPercentageAuto>Não—
bottomProp<LengthPercentageAuto>Não—
leftProp<LengthPercentageAuto>Não—
marginProp<LengthPercentageAuto>Não—
marginTopProp<LengthPercentageAuto>Não—
marginRightProp<LengthPercentageAuto>Não—
marginBottomProp<LengthPercentageAuto>Não—
marginLeftProp<LengthPercentageAuto>Não—
flexGrowProp<number>Não—
flexShrinkProp<number>Não—
flexBasisProp<SizeValue | "content">Não—
flexProp<number>NãoA grow factor from a zero basis, as CSS flex: n; 0 is inflexible.
alignSelfProp<"auto" | SelfAlignment>Não—
directionProp<"ltr" | "rtl">NãoThe way lines run; unset, the parent's, and the app's first language's at the root.
boxSizingProp<"border-box" | "content-box">Não—
paddingInlineStartProp<LengthPercentage>NãoPadding on the side lines start from: the left in ltr, the right in rtl.
paddingInlineEndProp<LengthPercentage>NãoPadding on the side lines end at: the right in ltr, the left in rtl.
marginInlineStartProp<LengthPercentageAuto>NãoMargin on the side lines start from: the left in ltr, the right in rtl.
marginInlineEndProp<LengthPercentageAuto>NãoMargin on the side lines end at: the right in ltr, the left in rtl.
insetInlineStartProp<LengthPercentageAuto>Nãoleft in ltr, right in rtl.
insetInlineEndProp<LengthPercentageAuto>Nãoright in ltr, left in rtl.
roleProp<Role>Não—
onAction(event: AccessibilityActionEvent) => voidNãoThe screen reader action taken, by name.
accessibleProp<boolean>NãoMakes the view one screen reader element, read as its label or its children's text.
labelProp<string>NãoWhat a screen reader says for the view.
hintProp<string>NãoWhat happens when the view is activated, read after the label.
aria-hiddenProp<boolean>NãoScreen readers skip the view and its subtree.
actionsProp<readonly AccessibilityAction[]>NãoActions a screen reader offers; onAction receives the one taken.
liveProp<"off" | "polite" | "assertive">NãoARIA's aria-live: announces changes to the view's content, on iOS too.
aria-disabledProp<boolean>Não—
aria-selectedProp<boolean>Não—
aria-checkedProp<boolean | "mixed">Não—
aria-busyProp<boolean>Não—
aria-expandedProp<boolean>Não—
aria-valueminProp<number>Não—
aria-valuemaxProp<number>Não—
aria-valuenowProp<number>Não—
aria-valuetextProp<string>Não—
gesturesreadonly Composable[]NãoThe view's gestures; several race unless composed with together or orElse.
opacityAnimatable<number>Não—
backgroundColorAnimatable<string>Não—
translateXAnimatable<number>Não—
translateYAnimatable<number>Não—
scaleAnimatable<number>Não—
scaleXAnimatable<number>Não—
scaleYAnimatable<number>Não—
rotateAnimatable<number>NãoDegrees.
transitionPartial<Record<"opacity" | "backgroundColor" | "transform" | "borderRadius" | "borderColor" | "shadow" | "width" | "height" | "all", Animation<unknown> | AnimationSpec>>NãoHow the animatable props move when they change, enter or leave, by group; a CSS transition compiles to it.
animatePartial<Record<AnimatableProps, string | number>>NãoAnimatable props whose every change moves as transition says; the first value applies at once.
enterEffectNãoWhere the view enters from: fade.and(slide.up(12)).
exitProp<Effect>NãoWhere the view leaves to; it stays on screen until it is there. The renderer gets true, and keeps the view until exited.
layoutAnimation<number>NãoHow the view moves to a new frame the layout gives it: layout={spring()}.
borderRadiusAnimatable<number>Não—
overflowProp<"visible" | "hidden" | "clip" | "scroll">Nãohidden and scroll clip; as in CSS, either lets a flex item shrink below its content.
borderWidthProp<number>Não—
borderColorAnimatable<string>Não—
shadowColorAnimatable<string>Não—
shadowRadiusAnimatable<number>Não—
shadowOffsetXAnimatable<number>Não—
shadowOffsetYAnimatable<number>Não—
backgroundGradient{ angle: number; colors: string[];}Não—
colorProp<string>Não—
sharedIdProp<string>NãoA 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).
srcProp<ImageSource>NãoA URL, or a bundled image as its import gives it.
objectFitProp<"none" | "cover" | "contain" | "fill">NãoCSS's object-fit: cover fills and crops, contain fits, fill distorts, none keeps its size, centered.
placeholderProp<string>NãoColor shown while the image loads.
fadeDurationProp<number>NãoCross-fade duration in milliseconds when the image appears; 0 by default.
tintColorProp<string>NãoRecolors the image's opaque pixels, for icons.
cacheProp<"none" | "memory-disk" | "memory" | "disk">NãoWhich caches may serve and keep the image; memory-disk by default.
thumbhashProp<string>NãoA ThumbHash of the image, in base64: its blurred preview shows, over placeholder, until the image loads.
onLoadStart — assinaturas de método

Assinaturas

ts
(event: KuitoEvent<"loadstart">): void

Parâmetros

NomeTipoObrigatórioDescrição
eventKuitoEvent<"loadstart">Sim—

Devolve

void

onLoad — assinaturas de método

Assinaturas

ts
(event: ImageLoadEvent): void

Parâmetros

NomeTipoObrigatórioDescrição
eventImageLoadEventSim—

Devolve

void

onError — assinaturas de método

Assinaturas

ts
(event: ImageErrorEvent): void

Parâmetros

NomeTipoObrigatórioDescrição
eventImageErrorEventSim—

Devolve

void

onLoadEnd — assinaturas de método

Assinaturas

ts
(event: KuitoEvent<"loadend">): void

Parâmetros

NomeTipoObrigatórioDescrição
eventKuitoEvent<"loadend">Sim—

Devolve

void

onPress — assinaturas de método

Assinaturas

ts
(event: PressEvent): void

Parâmetros

NomeTipoObrigatórioDescrição
eventPressEventSim—

Devolve

void

onPressCapture — assinaturas de método

Assinaturas

ts
(event: PressEvent): void

Parâmetros

NomeTipoObrigatórioDescrição
eventPressEventSim—

Devolve

void

onAction — assinaturas de método

Assinaturas

ts
(event: AccessibilityActionEvent): void

Parâmetros

NomeTipoObrigatórioDescrição
eventAccessibilityActionEventSim—

Devolve

void

backgroundGradient — campos aninhados

backgroundGradient campos

NomeTipoObrigatórioDescrição
anglenumberSim—
colorsstring[]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.