Toast

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add toast

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update toast

Preview

"use client"

import { Button } from "@registry/components/ui/button"
import { toastManager } from "@registry/components/ui/toast"

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 chooses the viewport corner or center edge. Use timeout to control dismissal and include actions only when users have enough time to reach them.

Import from the local file installed by the CLI.

"use client"

import { Button } from "@/components/ui/button"
import {
  toastManager,
  ToastProvider,
} from "@/components/ui/toast"

export default function App() {
  return (
    <ToastProvider>
      <ShowToastButton />
    </ToastProvider>
  )
}

function ShowToastButton() {
  return (
    <Button
      onClick={() =>
        toastManager.add({
          title: "Event created",
          description: "Your event is ready to share.",
        })
      }
    >
      Show toast
    </Button>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.