Toast

Docs

Toast

A succinct message that is displayed temporarily.

Installation

Run the following command:

npx shadcn-ui@latest add toast

Add the Toaster component

app/layout.tsx

import { Toaster } from "@/components/ui/toaster"
 
export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <head />
      <body>
        <main>{children}</main>
        <Toaster />
      </body>
    </html>
  )
}

Usage

The useToast hook returns a toast function that you can use to display a toast.

import { useToast } from "@/components/ui/use-toast"

export const ToastDemo = () => {
  const { toast } = useToast()
 
  return (
    <Button
      onClick={() => {
        toast({
          title: "Scheduled: Catch up",
          description: "Friday, February 10, 2023 at 5:57 PM",
        })
      }}
    >
      Show Toast
    </Button>
  )
}

To display multiple toasts at the same time, you can update the TOAST_LIMIT in use-toast.tsx.

Examples

Simple

With title

With Action

Destructive

Use toast({ variant: "destructive" }) to display a destructive toast.

Textarea Toggle