React Toast Notifications In SPFX

Introduction

 

The react-toast-notifications is a plugin written in React.js to generate toast notifications in React doms. Since this plugin is written in a React hooks concept, we are not able to use this in class component. Rather, we can use this in functional component.

 

Open a command prompt. Create a directory for the SPFx solution.

 

md spfx-ToastNotication

 

Navigate to the above-created directory.

 

cd spfx-ToastNotication

 

Run the Yeoman SharePoint Generator to create the solution.

 

yo @microsoft/sharepoint

 

Solution Name

 

Hit Enter to have the default name (spfx-ToastNotication in this case) or type in any other name for your solution.

Selected choice - Hit Enter

 

Target for the component

 

Here, we can select the target environment where we are planning to deploy the client web part; i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).

Selected choice - SharePoint Online only (latest).

 

Place of files

 

We may choose to use the same folder or create a subfolder for our solution.

Selected choice - same folder.

 

Deployment option

 

Selecting Y will allow the app to be deployed instantly to all sites and be accessible everywhere.

Selected choice - N (install on each site explicitly).

 

Permissions to access web APIs

 

Choose if the components in the solution require permission to access web APIs that are unique and not shared with other components in the tenant.

Selected choice - N (solution contains unique permissions)

 

Type of client-side component to create

 

We can choose to create a client-side web part or an extension. Choose the web part option.

Selected choice - WebPart

 

Web part name

 

Hit Enter to select the default name or type in any other name.

Selected choice - SpfxToast

 

Web part description

 

Hit Enter to select the default description or type in any other value.

 

Framework to use

 

Select any JavaScript framework to develop the component. Available choices are - No JavaScript Framework, React, and Knockout.

Selected choice - React

 

The Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.

 

Once the scaffolding process is completed, lock down the version of project dependencies by running the below command,

 

npm shrinkwrap

 

In the command prompt, type the below command to open the solution in the code editor of your choice.

 

NPM Packages Used,

 

On the command prompt, run the below commands

npm i react-toast-notifications

Necessary imports for Toast Notification plugin,

import { ToastProvider, useToasts } from 'react-toast-notifications' ;

Wrap your ToastComponent in the ToastProvider, which provides context for the Toast descendants.

e.g) 

export  const  MyReactToast = ({mycontent}) => (
    <ToastProvider>
      <ToastDemo mycontent={mycontent} />
    </ToastProvider>
  );

To intialize the toast notification,

const { addToast } = useToasts();
addToast(mycontent, {
     appearance: 'success',
     autoDismiss: false,
   }

Available apearance paramters are success, error, warning and info in default autodismiss is false.

 

You can set autodismiss by providing milliseconds.

<ToastProvider
        autoDismiss
        autoDismissTimeout={6000}
        placement="bottom-center">

Available placements are 'bottom-left' | 'bottom-center' | 'bottom-right' | 'top-left' | 'top-center' | 'top-right' 

 

The useToasts hook contains following signatures,

const { addToast, removeToast, removeAllToasts, updateToast, toastStack } = useToasts();

 in SpfxToast.tsx

import * as React from 'react';
import { ISpfxToastProps } from './ISpfxToastProps';
import { MyReactToast }from './Reacttoast';
export default class SpfxToast extends React.Component<ISpfxToastProps, {}> {
  public render(): React.ReactElement<ISpfxToastProps> {
    return (
      <div>
      <MyReactToast mycontent={"Hello it's Madhan"}/>
        </div>
    );
  }
}

in Reacttoast.tsx

import * as React from 'react';
import { ToastProvider,useToasts } from 'react-toast-notifications';

const  ToastDemo  = ({mycontent}) =>{
  const { addToast } = useToasts();
  return (
      <>
    <button onClick={() => addToast(mycontent, {
      appearance: 'success',
      autoDismiss: false,
      PlacementType :'bottom-left',
    })}>
      success Toast
    </button>
    <button onClick={() => addToast(mycontent, {
      appearance: 'error',
      autoDismiss: false,
    })}>
      error Toast
    </button>
    <button onClick={() => addToast(mycontent, {
      appearance: 'warning',
      autoDismiss: false,
    })}>
      warning Toast
    </button>
    <button onClick={() => addToast(mycontent, {
      appearance: 'info',
      autoDismiss: false,
    })}>
      Info Toast
    </button></>

  );
};
export  const  MyReactToast = ({mycontent}) => (
    <ToastProvider>
      <ToastDemo mycontent={mycontent} />
    </ToastProvider>
  );

Output

 

 

For more about reat toast notification visit here.

 

Conclusion

 

Hence we learned about initializing toast notifications in Spfx form using the react-toast-notifications plugin. I hope this helps someone. Happy coding :)