SplashScreen — Kuito Dokumentation

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.

Referenz

Signaturen

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`__0`	`SplashScreenProps`	Ja	—

Rückgabe

React.JSX.Element

Props: SplashScreenProps

Props (einschließlich geerbter Props) 99

Name	Typ	Erforderlich	Beschreibung
`children`	`KuitoNode`	Nein	Live content, drawn over the launch screen in the same window.
`id`	`string`	Nein	—
`ref`	`ElementRef<ElementHandle>`	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	—
`hidden`	`Prop<boolean>`	Nein	Takes the view out of layout and off screen, as CSS `display: none`.
`padding`	`Prop<LengthPercentage>`	Nein	—
`paddingTop`	`Prop<LengthPercentage>`	Nein	—
`paddingRight`	`Prop<LengthPercentage>`	Nein	—
`paddingBottom`	`Prop<LengthPercentage>`	Nein	—
`paddingLeft`	`Prop<LengthPercentage>`	Nein	—
`width`	`Animatable<SizeValue>`	Nein	—
`height`	`Animatable<SizeValue>`	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.
`position`	`Prop<"relative" \| "absolute">`	Nein	—
`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.
`opacity`	`Animatable<number>`	Nein	—
`backgroundColor`	`Animatable<string>`	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.
`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()}`.
`borderRadius`	`Animatable<number>`	Nein	—
`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	—
`borderColor`	`Animatable<string>`	Nein	—
`shadowColor`	`Animatable<string>`	Nein	—
`shadowRadius`	`Animatable<number>`	Nein	—
`shadowOffsetX`	`Animatable<number>`	Nein	—
`shadowOffsetY`	`Animatable<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	—
`keyboard`	`Prop<{ avoid?: "none" \| "padding" \| "position";}>`	Nein	—
`logo`	`SplashPartProps`	Nein	—
`brand`	`SplashPartProps`	Nein	—
`onReady`	`() => void`	Nein	Runs once the native splash is gone and this view is what shows.

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	—

onReady — Methodensignaturen

Signaturen

(): void

Parameter

Keine Parameter.

Rückgabe

void

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

#Animate the launch logo into the app

#Behavior

#Continue

Referenz

Signaturen

Parameter

Rückgabe

Props (einschließlich geerbter Props) 99

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

Signaturen

Parameter

Rückgabe

backgroundGradient Felder

Signaturen

Parameter

Rückgabe

Animate the launch logo into the app

Behavior

Continue