# SplashScreen

Source: /tuil/docs/reference/components/workflow/splash-screen
Locale: en

SplashScreen component API, behavior, and executable example.





{/* Generated by tooling/docs/generate-reference.ts. */}

<PublishedStory storyId="component-acceptance" variant="Workflow" />

## API and events [#api-and-events]

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

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

### Props, functions, and events [#props-functions-and-events]

| Member     | Type                                       | Required | Description                                                                     | Related types |
| ---------- | ------------------------------------------ | -------- | ------------------------------------------------------------------------------- | ------------- |
| `id`       | `string \| undefined`                      | No       | The `id` member uses the `string \| undefined` contract.                        | —             |
| `logo`     | `string \| readonly string[] \| undefined` | No       | The `logo` member uses the `string \| readonly string[] \| undefined` contract. | —             |
| `title`    | `string`                                   | Yes      | The `title` member uses the `string` contract.                                  | —             |
| `message`  | `string \| undefined`                      | No       | The `message` member uses the `string \| undefined` contract.                   | —             |
| `progress` | `number \| undefined`                      | No       | The `progress` member uses the `number \| undefined` contract.                  | —             |
| `status`   | `string \| undefined`                      | No       | The `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 [#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 [#complete-import]

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