Match the native launch screen with an animated view. Use it to transition the launch artwork into your first screen.

Animate the launch logo into the app

tsx
import { Box, Show, SplashScreen, Text, motion, signal, timing } from 'kuito';

export default function App() {
  const splash = signal(true);
  const scale = motion(1);
  const opacity = motion(1);

  return (
    <Box flex={1}>
      <Text padding={16}>Home</Text>
      <Show when={splash.value}>
        <SplashScreen
          opacity={opacity}
          logo={{ scale }}
          onReady={() => {
            scale.value = timing(450).to(6);
            opacity.value = timing({ duration: 450, onEnd: () => (splash.value = false) }).to(0);
          }}
        />
      </Show>
    </Box>
  );
}

Behavior

Wait for onReady before beginning the handoff animation. Configure the source artwork in kuito.config.ts. Remove the overlay after the animation so it no longer covers the app.

Continue

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

Référence

Signatures

ts
({ logo, brand, onReady, children, ...props }: SplashScreenProps): React.JSX.Element

Paramètres

NomTypeRequisDescription
__0SplashScreenPropsOui—

Retourne

React.JSX.Element

Props: SplashScreenProps

Props (props héritées incluses) 99

NomTypeRequisDescription
childrenKuitoNodeNonLive content, drawn over the launch screen in the same window.
idstringNon—
refElementRef<ElementHandle>Non—
classProp<ClassNames>NonClass names from a .css import or styles(): a string, or a list with falsy entries skipped, following the signals it reads.
styleStyleDeclarationsNonStyles 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) => voidNon—
onPressCapture(event: PressEvent) => voidNon—
keystring | numberNon—
hiddenProp<boolean>NonTakes the view out of layout and off screen, as CSS display: none.
paddingProp<LengthPercentage>Non—
paddingTopProp<LengthPercentage>Non—
paddingRightProp<LengthPercentage>Non—
paddingBottomProp<LengthPercentage>Non—
paddingLeftProp<LengthPercentage>Non—
widthAnimatable<SizeValue>Non—
heightAnimatable<SizeValue>Non—
minWidthProp<SizeValue>Non—
maxWidthProp<SizeValue>Non—
minHeightProp<SizeValue>Non—
maxHeightProp<SizeValue>Non—
aspectRatioProp<number>NonWidth divided by height; sizes the missing side from the other.
positionProp<"relative" | "absolute">Non—
topProp<LengthPercentageAuto>Non—
rightProp<LengthPercentageAuto>Non—
bottomProp<LengthPercentageAuto>Non—
leftProp<LengthPercentageAuto>Non—
marginProp<LengthPercentageAuto>Non—
marginTopProp<LengthPercentageAuto>Non—
marginRightProp<LengthPercentageAuto>Non—
marginBottomProp<LengthPercentageAuto>Non—
marginLeftProp<LengthPercentageAuto>Non—
flexGrowProp<number>Non—
flexShrinkProp<number>Non—
flexBasisProp<SizeValue | "content">Non—
flexProp<number>NonA grow factor from a zero basis, as CSS flex: n; 0 is inflexible.
alignSelfProp<"auto" | SelfAlignment>Non—
directionProp<"ltr" | "rtl">NonThe way lines run; unset, the parent's, and the app's first language's at the root.
boxSizingProp<"border-box" | "content-box">Non—
paddingInlineStartProp<LengthPercentage>NonPadding on the side lines start from: the left in ltr, the right in rtl.
paddingInlineEndProp<LengthPercentage>NonPadding on the side lines end at: the right in ltr, the left in rtl.
marginInlineStartProp<LengthPercentageAuto>NonMargin on the side lines start from: the left in ltr, the right in rtl.
marginInlineEndProp<LengthPercentageAuto>NonMargin on the side lines end at: the right in ltr, the left in rtl.
insetInlineStartProp<LengthPercentageAuto>Nonleft in ltr, right in rtl.
insetInlineEndProp<LengthPercentageAuto>Nonright in ltr, left in rtl.
roleProp<Role>Non—
onAction(event: AccessibilityActionEvent) => voidNonThe screen reader action taken, by name.
accessibleProp<boolean>NonMakes the view one screen reader element, read as its label or its children's text.
labelProp<string>NonWhat a screen reader says for the view.
hintProp<string>NonWhat happens when the view is activated, read after the label.
aria-hiddenProp<boolean>NonScreen readers skip the view and its subtree.
actionsProp<readonly AccessibilityAction[]>NonActions a screen reader offers; onAction receives the one taken.
liveProp<"off" | "polite" | "assertive">NonARIA's aria-live: announces changes to the view's content, on iOS too.
aria-disabledProp<boolean>Non—
aria-selectedProp<boolean>Non—
aria-checkedProp<boolean | "mixed">Non—
aria-busyProp<boolean>Non—
aria-expandedProp<boolean>Non—
aria-valueminProp<number>Non—
aria-valuemaxProp<number>Non—
aria-valuenowProp<number>Non—
aria-valuetextProp<string>Non—
gesturesreadonly Composable[]NonThe view's gestures; several race unless composed with together or orElse.
opacityAnimatable<number>Non—
backgroundColorAnimatable<string>Non—
translateXAnimatable<number>Non—
translateYAnimatable<number>Non—
scaleAnimatable<number>Non—
scaleXAnimatable<number>Non—
scaleYAnimatable<number>Non—
rotateAnimatable<number>NonDegrees.
transitionPartial<Record<"opacity" | "backgroundColor" | "transform" | "borderRadius" | "borderColor" | "shadow" | "width" | "height" | "all", Animation<unknown> | AnimationSpec>>NonHow the animatable props move when they change, enter or leave, by group; a CSS transition compiles to it.
animatePartial<Record<AnimatableProps, string | number>>NonAnimatable props whose every change moves as transition says; the first value applies at once.
enterEffectNonWhere the view enters from: fade.and(slide.up(12)).
exitProp<Effect>NonWhere the view leaves to; it stays on screen until it is there. The renderer gets true, and keeps the view until exited.
layoutAnimation<number>NonHow the view moves to a new frame the layout gives it: layout={spring()}.
borderRadiusAnimatable<number>Non—
overflowProp<"visible" | "hidden" | "clip" | "scroll">Nonhidden and scroll clip; as in CSS, either lets a flex item shrink below its content.
borderWidthProp<number>Non—
borderColorAnimatable<string>Non—
shadowColorAnimatable<string>Non—
shadowRadiusAnimatable<number>Non—
shadowOffsetXAnimatable<number>Non—
shadowOffsetYAnimatable<number>Non—
backgroundGradient{ angle: number; colors: string[];}Non—
colorProp<string>Non—
sharedIdProp<string>NonA 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).
alignItemsProp<SelfAlignment>Non—
justifyContentProp<ContentAlignment>Non—
gapProp<LengthPercentage>Non—
rowGapProp<LengthPercentage>Non—
columnGapProp<LengthPercentage>Non—
flexDirectionProp<"row" | "column" | "row-reverse" | "column-reverse">Non—
flexWrapProp<"nowrap" | "wrap" | "wrap-reverse" | "balance">Non—
flexLineCountProp<number>NonThe minimum number of lines a wrapping container breaks into (CSS Flexbox 2).
alignContentProp<ContentAlignment>Non—
keyboardProp<{ avoid?: "none" | "padding" | "position";}>Non—
brandSplashPartPropsNon—
onReady() => voidNonRuns once the native splash is gone and this view is what shows.
onPress — signatures de méthode

Signatures

ts
(event: PressEvent): void

Paramètres

NomTypeRequisDescription
eventPressEventOui—

Retourne

void

onPressCapture — signatures de méthode

Signatures

ts
(event: PressEvent): void

Paramètres

NomTypeRequisDescription
eventPressEventOui—

Retourne

void

onAction — signatures de méthode

Signatures

ts
(event: AccessibilityActionEvent): void

Paramètres

NomTypeRequisDescription
eventAccessibilityActionEventOui—

Retourne

void

backgroundGradient — champs imbriqués

backgroundGradient champs

NomTypeRequisDescription
anglenumberOui—
colorsstring[]Oui—
onReady — signatures de méthode

Signatures

ts
(): void

Paramètres

Aucun paramètre.

Retourne

void

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.