Toast

A message that arrives and leaves on its own.

import { Toast } from '@textui/core';

<Toast tone="success" message="Deployed to eu-west-1" />

Props

| Prop | Type | Default | | | — | — | — | — | | message | string | required | | | tone | 'default' \| 'primary' \| 'secondary' \| 'accent' \| 'success' \| 'warning' \| 'danger' \| 'info' \| 'muted' | 'info' | | | title | string | | | | icon | string | | |

Plus everything on BoxProps.

Role: status.

The message itself. Placement, stacking and expiry belong to ToastHost, and one is normally created through the app’s notify helper rather than mounted directly.

Never put anything in a toast that the reader must act on - it will be gone.

See also

  • ToastHost - where they stack and when they leave
  • Alert - a message that stays

Back to top

MIT licensed. Pre-1.0 - the surface is still moving.