react-toastify

What is react-toastify?

The react-toastify package allows developers to add customizable notification toasts to their React applications. It provides an easy way to display success, error, warning, and informational messages with a variety of animations, positions, and options.

What are react-toastify's main functionalities?

Displaying Toast Notifications

This feature allows you to display a simple toast notification with a message. The toast function can be called with a string message to display it to the user.

import { toast } from 'react-toastify';
toast('Hello World!');

Customizing Toast Appearance

This feature allows you to customize the appearance and behavior of the toast. You can specify the type (like success, error, etc.), position, auto-close time, and many other options.

import { toast } from 'react-toastify';
toast.success('Success!', {
  position: "top-right",
  autoClose: 5000,
  hideProgressBar: false,
  closeOnClick: true,
  pauseOnHover: true,
  draggable: true,
  progress: undefined,
});

Custom Rendered Components

This feature allows you to render a custom React component inside the toast. This is useful for creating complex toasts with custom layouts and functionality.

import { toast } from 'react-toastify';
const CustomToast = ({ closeToast }) => (
  <div>
    Something went wrong! <button onClick={closeToast}>Close</button>
  </div>
);
toast(<CustomToast />);

Updating Existing Toasts

This feature allows you to update an existing toast's content or appearance. You can change the message, type, or any other property of the toast after it has been displayed.

import { toast } from 'react-toastify';
const toastId = React.useRef(null);

const updateToast = () => {
  toast.update(toastId.current, { type: toast.TYPE.INFO, render: 'Updated!' });
};

// Create a toast and save its ID
toastId.current = toast('Initial message');

Controlling Toasts Programmatically

This feature gives you programmatic control over the toasts. You can dismiss all toasts or specific toasts by their ID, which can be useful in scenarios where user actions or other events should close notifications.

import { toast } from 'react-toastify';

// Display a toast
toast('Will close in 5 seconds', { autoClose: 5000 });

// Dismiss all toasts on demand
toast.dismiss();

// Dismiss a specific toast by ID
toast.dismiss(toastId.current);

Other packages similar to react-toastify

notistack

Notistack is a Snackbar notification library that can be used with Material-UI. It allows for stacking notifications and offers similar customization options. Compared to react-toastify, it is more tightly integrated with Material-UI components and design patterns.

react-notification-system

React Notification System is another package for adding notifications to a React app. It provides a different set of customization options and a slightly different API. It is less maintained compared to react-toastify and might not have as many features.

sweetalert2-react-content

SweetAlert2 with React content is a package for creating beautiful, responsive, customizable, and accessible (WAI-ARIA) replacement for JavaScript's popup boxes with React content. It is more focused on modal dialogs and alerts rather than toasts, but it can be used for similar notification purposes.

README

React Toastify

React-Toastify allow you to add toast notification to your app with ease.

• Demo
• Installation
• Features
• How it works ?
• Api
• Release Notes
• Contribute
• License

Demo

Live demo here

Installation

$ npm install --save react-toastify
$ yarn add react-toastify

If you use a style loader you can import the stylesheet as follow :

import 'react-toastify/dist/ReactToastify.min.css' 

Features

• Can display a react component inside the toast !
• Don't rely on findDOMNode
• Has onOpen and onClose hooks. Both can access the props passed to the react component rendered inside the toast
• Can be positioned
• Can remove toast programmatically
• Define behavior per toast
• Easy to setup
• Super easy to customize

How it works ?

The component use a dead simple pubsub(observer pattern) to listen and trigger event. The pubsub allow us to display a toast from everywhere in our app.

• Add a ToastContainer to your app

//index.js
import React from 'react';
import { render } from 'react-dom';
import { ToastContainer } from 'react-toastify';
import 'react-toastify/dist/ReactToastify.min.css'; 

const App = () => {
  return (
    <div>
        {/*Your others component*/}
      <ToastContainer />
    </div>
  );
};

render(
  <App/>,
  document.getElementById('root')
);

• Display a Toast from everywhere !

//foo.js
import React from 'react';
import { toast } from 'react-toastify';

const Greet = ({ name }) => <div>Hello {name}</div>
    
function handleClick() {
    toast(<Greet name="John" />);
}
    
const ToastBtn = () => {
    return(
        <button onClick={handleClick}>My Awesome Button</button>
    )
}

Api

ToastContainer (Type : React Component)

Props	Type	Default	Description
position	string	top-right	Define where the toast appear
autoClose	false|int	5000	Delay in ms to close the toast. If set to false, the notification need to be closed manualy
className	string	-	Add optional classes to the container
style	object	-	Add optional inline style to the container
closeButton	React Element|false	-	A React Component to replace the default close button or false to hide the button
hideProgressBar	bool	false	Display or not the progress bar below the toast(remaining time)

• Position accept the following value :

top-right, top-center, top-left, bottom-right, bottom-center, bottom-left

You can use the toast object to avoid any typo :

import { toast } from 'react-toastify';
      
toast.POSITION.TOP_LEFT, toast.POSITION.TOP_RIGHT, toast.POSITION.TOP_CENTER
toast.POSITION.BOTTOM_LEFT,toast.POSITION.BOTTOM_RIGHT, toast.POSITION.BOTTOM_CENTER

• When using a custom close button, the component will receive a prop closeToast. You need to call it to close the toast.

//The classname toastify__close is used to position the icon on the top right side, you don't need it.
const FontAwesomeCloseButton = ({ closeToast }) => (
  <i
    className="toastify__close fa fa-times"
    onClick={closeToast}
  />
);

...
<ToastContainer autoClose={false} position="top-center" closeButton={<FontAwesomeCloseButton />}/>
...

toast (Type: Object)

All the method of toast return a toastId except dismiss. The toastId can be used to remove a toast programmatically. All the method but dismiss can take 2 parameters :

Parameter	Type	Required	Description
content	string|React Element	✓	Element that will be displayed
options	object	✘	Possible keys : autoClose, type, closeButton, hideProgressBar

• Available options :
  • type: Kind of notification. One of "default", "success", "info", "warning", "error". You can use toast.TYPE.INFO and so on to avoid any typo.
  • onOpen: callback before showing the notification. If you display a component its props will be passed to the callback as first parameter.
  • onClose: callback after closing the notification. If you display a component its props will be passed to the callback as first parameter.
  • autoClose: same as ToastContainer.
  • closeButton: same as ToastContainer.
  • hideProgressBar: same as ToastContainer.

:warning:️ autoClose, closeButton, hideProgressBar, supersede ToastContainer props :warning:

const Img = ({ src }) => <div><img width={48} src={src} /></div>;
const options = {
    onOpen: props => console.log(props.foo),
    onClose: props => console.log(props.foo),
    autoClose: 6000, 
    closeButton: <FontAwesomeCloseButton />,
    type: toast.TYPE.INFO,
    hideProgressBar: false
};

// each method return a toast id except dismiss.   
const toastId = toast(<Img foo={bar}/>, options) // default, type: 'default'
toast.success("Hello", options) // add type: 'success' to options
toast.info("World", options) // add type: 'info' to options
toast.warn(<Img />, options) // add type: 'warning' to options
toast.error(<Img />, options) // add type: 'error' to options
toast.dismiss() // Remove all toasts !
toast.dismiss(toastId) // Remove given toast

Release Notes

v1.6.0

New Features

• Can now remove a toast programmatically. When you display a toast, the function return a toastId. You can use it as follow to remove a given toast toast.dismiss(toastId)
• If the container is not mounted, the notification will be added to a queue and dispatched as soon as the container is mounted. For more details check issue #4

Others

• Added --no-idents flag to cssnano to avoid animation name collision with others libs.
• Tests are no longer transpiled

v1.5.0

• That version does not bring any features but it brings tests made with the amazing jest and aslo Travis CI integration.

v1.4.3

• React and react-dom are now peer dependencies

v1.4.2

• Don't try to pass down the props when we render a string like so : toast(<div>hello</div>)

Bug fix

• Fixed the test to check if the toast can be rendered

v1.4.0

• React v16 ready : moving to prop-types and react-transition-group
• Internal rewrite of components. The implementation wasn't bad but it wasn't good either. A better props validation has been added has well.
• Removed useless dependencies. I was using the Object.values polyfill when a one line forEach can do the same is my case.
• Now I believe it's even easier to style the components. The sass sources files are now included when you install the package via yarn or npm
• The default close button has been replaced.

New Features

• A progress bar is now visible to track the remaining time before the notification is closed. Of course if you don't like it, you are free to disable it.
• You can choose to display a close button or not.
• Event pointer is set to none to avoid losing pointer events on everything beneath the toast container when no toast are displayed
• The closeToast callback is also passed down to your component.

v1.3.0

• PropTypes package update
• Dead code elimination

New Features

• Possibility to use a custom close button. Check the api docs of ToastContainer and toast.

v1.2.2

I was storing react component into state which is a bad practice. What should Go in State This is no more the case now. The separation of concern between the data and the view is respected.

Bug fix

• Was calling cloneElement on undefined which cause your console bleed. See issue #2

v1.2.1

Bug fix

• Added Object.values polyfill otherwise won't work with IE or EDGE. I ♥ IE.

v1.1.1

Bug fix

• OnClose and OnOpen can access all the props passed to the component. Before only the props passed using toast options were accessible

New Features

• Passing prop using toast option will be removed at the next release. It doesn't make sense to keep both way to pass props. Use the react way instead

v1.1.0

New Features

• Added onOpen callback
• Added onClose callback

Contribute

Any suggestions and pull request are welcome !

License

Licensed under MIT