# Splash Screen

Styled startup banner with big ASCII art title, subtitle, author credit, and status line



<ComponentPreview base="opentui" name="splash-screen-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/opentui-splash-screen
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="opentui" name="splash-screen" title="components/ui/splash-screen.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { SplashScreen } from "@/components/ui/splash-screen";
```

```tsx
<SplashScreen
  title="MyCLI"
  subtitle="The modern developer toolkit"
  author={{ name: "Jane Doe", href: "https://example.com" }}
  statusLine={<Text color="green">● Ready on port 3000</Text>}
/>
```

API Reference [#api-reference]

SplashScreen [#splashscreen]

| Prop            | Type                              | Default    |
| --------------- | --------------------------------- | ---------- |
| `title`         | `string`                          | `required` |
| `font`          | `"block" \| "simple"`             | `"block"`  |
| `titleColor`    | `string`                          | -          |
| `titleColorAlt` | `string`                          | -          |
| `bold`          | `boolean`                         | `true`     |
| `subtitle`      | `string`                          | -          |
| `subtitleDim`   | `boolean`                         | `true`     |
| `author`        | `{ name: string; href?: string }` | -          |
| `statusLine`    | `ReactNode`                       | -          |
| `padding`       | `number`                          | `2`        |
| `align`         | `"left" \| "center"`              | -          |