tuil
ReferenceComponentsWorkflow UI

SplashScreen

SplashScreen component API, behavior, and executable example.

View rawEdit

Loading executable example…

API and events

Bind observable workflow and operation snapshots to guided terminal flows, progress, errors, cancellation, splash state, and contextual help.

export function SplashScreen({
  id = "splash",
  logo,
  title,
  message,
  progress,
  status,
}: SplashScreenProps): ReactNode;

Props, functions, and events

MemberTypeRequiredDescriptionRelated types
idstring | undefinedNoThe id member uses the string | undefined contract.
logostring | readonly string[] | undefinedNoThe logo member uses the string | readonly string[] | undefined contract.
titlestringYesThe title member uses the string contract.
messagestring | undefinedNoThe message member uses the string | undefined contract.
progressnumber | undefinedNoThe progress member uses the number | undefined contract.
statusstring | undefinedNoThe status member uses the string | undefined contract.

The runner emits the complete workflow:* lifecycle; operation components reflect operation snapshots and callbacks.

Callback props run after the documented input is accepted. Callbacks are not cancellable unless their return type or description states otherwise.

Interaction and capabilities

Controls call the runner's next, back, skip, retry, cancel, and rollback operations with transition locking.

The published manifest records keyboard, focus, pointer, theme, terminal, semantic, event, and dependency requirements.

Complete import

import { SplashScreen } from "@/components/tuil/workflows/workflow";

On this page