Package Exports
- react-compact-toast
- react-compact-toast/styles.css
Readme
âĻ Features
- ðŠķ Lightweight: â2KB gzipped
- ðŊ Zero dependencies: No external dependencies
- ðĻ Fully customizable: Style with any CSS framework (Tailwind, Emotion, etc.)
- ⥠Fast: Optimized for performance
- ð§ TypeScript: Full TypeScript support
- ð Flexible: Custom icons, colors, and animations
ðĶ Installation
# npm
npm install react-compact-toast
# yarn
yarn add react-compact-toast
# pnpm
pnpm add react-compact-toast
ð Quick Start
import { ToastContainer, toast } from 'react-compact-toast';
function App() {
return (
<div>
<ToastContainer />
<button
onClick={() => toast({ text: 'Hello World!', position: 'topRight' })}
>
Show Toast
</button>
</div>
);
}
ð Basic Usage
1. Add ToastContainer
Add the ToastContainer
component to your app (usually in your main App component):
import { ToastContainer } from 'react-compact-toast';
function App() {
return (
<div>
{/* Your app content */}
<ToastContainer />
</div>
);
}
2. Show Toasts
import { toast } from 'react-compact-toast';
// Simple toast
toast('Hello World!');
// Toast with options
toast({
text: 'Custom notification',
position: 'topRight',
autoClose: 5000,
icon: 'ð',
});
Documentation
Find the full API reference on documentation.