# Toast

Auto-dismissing toast notification



<ComponentPreview base="opentui" name="toast-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-toast
    ```
  </TabsContent>

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

      <ComponentSource base="opentui" name="toast" title="components/ui/toast.tsx" />

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

Usage [#usage]

```tsx
import { Toast } from "@/components/ui/toast";
```

```tsx
<Toast
  variant="success"
  message="Settings saved successfully."
  duration={5000}
  onDismiss={() => console.log("toast closed")}
/>
```

Examples [#examples]

Error with Longer Duration [#error-with-longer-duration]

<ComponentPreview base="opentui" name="toast-error" />

API Reference [#api-reference]

Toast [#toast]

| Prop        | Type                                          | Default    |
| ----------- | --------------------------------------------- | ---------- |
| `message`   | `string`                                      | `required` |
| `variant`   | `"success" \| "error" \| "warning" \| "info"` | `"info"`   |
| `duration`  | `number`                                      | `3000`     |
| `onDismiss` | `() => void`                                  | -          |
| `icon`      | `string`                                      | -          |