| title | Toast Options |
|---|---|
| description | Options to customize the toast component. |
| category | Customization |
import { Toaster } from "@pheralb/toast";
<Toaster toastOptions={{}} />;By default, the font of the toasts is:
ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, Segoe
UI, Roboto, Helvetica Neue, Arial, Noto Sans, sans-serif, Apple Color Emoji,
Segoe UI Emoji, Segoe UI Symbol, Noto Color Emoji;You can change this value using the font property. In this case, we are using the utility class font-sans from Tailwind CSS to set the font:
<Toaster
toastOptions={{
font: "font-sans",
}}
/>@pheralb/toast use Phosphor Icons by default. You can change the default icons for all toasts using icons property:
import { Info, CircleX, CircleAlert, CircleCheck, Loader } from "lucide-react";
<Toaster
toastOptions={{
icons: {
info: <Info className="dark:text-blue-500" />,
error: <CircleX className="text-red-500" />,
warning: <CircleAlert className="text-yellow-500" />,
success: <CircleCheck className="text-green-500" />,
loading: <Loader className="animate-spin text-gray-500" />,
},
}}
/>;💡 To modify the icon of a single toast:
toast - Custom Icon
By default, the animation when closing a toast is slide (slide-down or slide-up). You can change this value using the animationOnClose property:
defaultActionContent: Default content for the action button. It can be a string or aReactNode.
<Toaster
toastOptions={{
defaultActionContent: "Close me",
}}
/>💡 To modify the action button of a single toast:
toast - toast.variant with action
defaultCloseContent: Default content for the close button. It can be a string or aReactNode.
<Toaster
toastOptions={{
defaultCloseContent: "Close",
}}
/>You can extend the default styles of the toasts using the classNames property. For example, to change the background color of the toasts using Tailwind CSS:
<Toaster
toastOptions={{
classNames: {
toast: "bg-zinc-100 dark:bg-zinc-900",
},
}}
/>Disable all default styles using headless property. It works together with classNames. For example, to create a custom toast with Tailwind CSS:
toastOptionsfrom<Toaster />accepts the following properties:
| Property | Description | Type | Required |
|---|---|---|---|
font |
Font for all toasts | string |
- |
icons |
Icons for all toasts | Record<Variant, ReactNode> |
- |
defaultActionContent |
Default content for the action button | string or ReactNode |
- |
defaultCloseContent |
Default content for the close button | string or ReactNode |
- |
headless |
Disable all default styles. It works together with classNames |
boolean |
- |
classNames |
Custom styles for all toasts | ToastClassnames |
- |
classNamesfromtoastOptionsaccepts the following properties:
| Property | Description | Type | Required |
|---|---|---|---|
toast |
Global toast style | string |
- |
container |
Toast container styles | string |
- |
icon |
Styles for the main icon of the toast | string |
- |
content |
Styles for title and description | string |
- |
actions |
Styles for the buttons | string |
- |