Skip to content
UI
On this page

Toast

Displays stacked and anchored toast notifications.

Overview

Copy the source into your project. Import the parts that you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without a wrapper or replacement package.

Preview

Notification toast

Installation

Run the init command from your project root first. The CLI configures StyleX and installs shared files and dependencies.

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. The CLI keeps existing files.

Usage

Mount ToastProvider once, then call toastManager.add({ title: "Saved" }) after an action.

Use anchoredToastManager with AnchoredToastProvider for anchor-positioned notifications. Keep the matching provider mounted while sending updates or closing a toast.

ToastProvider position selects the viewport corner or center edge. Use timeout to control dismissal. Include actions only if users have sufficient time to reach them. The icon-only close control has the accessible name Dismiss notification.

Import from the local file installed by the CLI.

API reference

The generator reads the component TypeScript source. Only component and Base UI props appear below. The Required column shows whether you must supply a property. It does not mean you must use the component.

View API reference