Toast
Imperative notification API (`toast.success`, `toast.error`). Differentiates `role="alert"` from `role="status"`.
Preview
example.tsxtsx
Installation
Install the individual package:
$ pnpm add @sisyphos-ui/toast @sisyphos-ui/coreOr use the umbrella package that bundles everything:
$ pnpm add @sisyphos-ui/uiUsage
Import the component styles and the component itself:
snippet.tsxtsx
import "@sisyphos-ui/toast/styles.css";
import { Toast } from "@sisyphos-ui/toast";Title + description
Second argument accepts `{ description, duration, dismissible, … }`.
example.tsxtsx
With undo action
Pass any ReactNode as `action`. Use `toast.dismiss(id)` to close from inside the action.
example.tsxtsx
All positions
Pick any of the six anchor points. The `<Toaster />` itself drives layout.
example.tsxtsx
API
Props table is being written. See the package README for the complete API surface.
The full API including refs, ARIA attributes, and HTML passthroughs lives in the package README.
Was this page helpful?
Edit this page on GitHub