1.0.4 • Published 12 months ago
@raxeraditya/beautiful-toast v1.0.4
Beautiful Toast
A beautiful, modern toast component for React applications with TailwindCSS.
Installation
npm install @raxeraditya/beautiful-toastUsage
- First, ensure you have TailwindCSS set up in your project and add the following to your tailwind.config.js:
module.exports = {
content: [
// ... your content configuration
"./node_modules/@aditya/beautiful-toast/**/*.{js,ts,jsx,tsx}",
],
};- Import and use the toast component:
import { showToast } from "@aditya/beautiful-toast";
// Show a success toast
showToast({
message: "Successfully saved!",
variant: "success",
onUndo: () => console.log("Undo clicked"),
});
// Show an error toast
showToast({
message: "Something went wrong!",
variant: "error",
});
// Show an info toast
showToast({
message: "New update available",
variant: "info",
});- Add the Toaster component to your app:
import { Toaster } from "sonner";
function App() {
return (
<>
{/* Your app content */}
<Toaster position="bottom-right" />
</>
);
}API
showToast Options
| Property | Type | Default | Description |
|---|---|---|---|
| message | string | (required) | Toast message content |
| variant | 'default' | 'success' | 'error' | 'info' | 'default' | Toast variant style |
| duration | number | 4000 | Duration in milliseconds |
| onUndo | () => void | undefined | Optional undo callback |
| icon | React.ReactNode | undefined | Optional custom icon |
License
MIT