# Toast

> Brief messages that stack in a corner and dismiss themselves.

```tsx
'use client';

import { Button, ToastProvider, useToast } from '@brand-studio/ui';

function AddToBasket() {
  const toast = useToast();
  return (
    <Button onClick={() => toast.add({ title: 'Added to basket', description: 'Ethiopia Guji, 250 g' })}>
      Add to basket
    </Button>
  );
}

export default function ToastDemo() {
  return (
    <ToastProvider>
      <AddToBasket />
    </ToastProvider>
  );
}
```

## Installation

```sh
npm install @brand-studio/ui
```

React 18 or 19 is a peer dependency. Import the stylesheet once and wrap the app in a brand theme:

```tsx
import '@brand-studio/ui/styles.css';
import { BrandTheme, ToastProvider } from '@brand-studio/ui';
import brand from './brand.json';

<BrandTheme palette={brand.tokens} mode="system">
  {/* your app */}
</BrandTheme>
```

## Usage

```tsx
import { ToastProvider, useToast } from '@brand-studio/ui';
```

```tsx
function SaveButton() {
  const toast = useToast();
  return <Button onClick={() => toast.add({ title: 'Saved' })}>Save</Button>;
}

<ToastProvider>
  <SaveButton />
</ToastProvider>
```

## Accessibility

- Toasts are announced to screen readers and dismiss after five seconds; hovering or focusing pauses the timer.
- F6 moves focus to the toast region. Swipe or press the close button to dismiss.
- Call `useToast()` anywhere inside `ToastProvider`.

## API Reference

| Prop | Type | Default |
|---|---|---|
| `children` | `React.ReactNode` | – |
| `timeout?` | `number` | `5000` |
| `limit?` | `number` | `3` |
| `closeLabel?` | `string` | `'Dismiss'` |

Source: https://brandstudio.js.org/docs/components/toast/
