Home

Awesome

<p align="center"> <img src="https://user-images.githubusercontent.com/53334880/102553638-6960d780-40d8-11eb-8816-ae151308a07e.png" alt="React Toast" /> <h3 align="center">React Toast</h3> </p> <h6 align="center"> Minimal toast notifications for React. </h3> <p align="center"> <a href="https://www.npmjs.com/package/react-toast" target="_blank"> <img src="https://img.shields.io/npm/v/react-toast?color=cc3534" /> </a> <a href="https://www.npmjs.com/package/react-toast" target="_blank"> <img src="https://img.shields.io/npm/dm/react-toast?color=%2344cc10" /> </a> <a href="https://bundlephobia.com/result?p=react-toast@1.0.1" target="_blank"> <img src="https://img.shields.io/bundlephobia/minzip/react-toast/1.0.1?color=%23165be4"> </a> </p>

Get started

Quick start

Install with yarn

yarn add react-toast

Install with NPM

npm install react-toast
import { ToastContainer, toast } from 'react-toast'

const App = () => {
  const wave = () => toast('Hi there 👋')

  return (
    <div>
      <button onClick={wave}>Say hi!</button>
      <ToastContainer />
    </div>
  )
}

Demo

Demo on CodeSandbox.

Docs

Toast Container

To use react-toast, you need to put ToastContainer in a top-level component in your application. e.g. App.js

It can take some props, here's a list of them:

PropsTypeDescriptionDefault
positiontop-left | top-center | top-right | bottom-left | bottom-center | bottom-rightposition of toastbottom-left
delay (ms)numberdelay for toast6000

Toast

There are 4 base toast type available, success, error, info and warn. For instance:

const success = () => toast.success('Message sent successfully!')

or

fetch('someRandomUrl')
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => toast.error(err.message))

Custom toast

You can display custom styled toasts, here's an example and a list of options that are available for customization:

const customToast = () =>
  toast('Morning! Have a good day.', {
    backgroundColor: '#8329C5',
    color: '#ffffff',
  })
PropertyTypeDescriptionDefault
backgroundColorstringbackground color of toastbased on toast type, e.g. success will be green
colorstringcolor of text in toast#ffffff

License

MIT