Toast

An accessible and beautiful toast library for React.

Framework guides

Install on Next.js Install on Remix

Getting Started

Install the library:

# Using npm:
npm install @pheralb/toast
 
# Using pnpm:
pnpm add @pheralb/toast
 
# Using yarn:
yarn add @pheralb/toast

Add the toast provider:

// 📃 main.tsx
import { ToastProvider } from '@pheralb/toast';
 
ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <ToastProvider>
      <App />
    </ToastProvider>
  </React.StrictMode>,
);

Usage:

// 📃 index.tsx
export default function Index() {
  const toast = useToast();
  return (
    <>
      <button
        onClick={() =>
          toast.success({
            text: 'pheralb/toast',
            description: '✨ A beautiful toast library for React',
          })
        }
      >
        <span>Render a toast</span>
      </button>
    </>
  );
}