Restrict the maximum toast to show in JavaScript Toast control

29 Mar 2023 / 2 minutes to read

You can restrict the maximum toast count by using the event callback function and terminate the toast displaying process by setting the cancel event property in the beforeOpen event.

The following sample demonstrates restricting toast displaying up to 3. You can restrict by your own count with custom code blocks.

Source

Preview

index.ts

index.html

import {Toast, ToastModel} from '@syncfusion/ej2-notifications';
import { enableRipple } from '@syncfusion/ej2-base';

enableRipple(true);

let maxCount: number = 3;
let toasts: ToastModel[] = [
{ title: 'Warning !', content: 'There was a problem with your network connection.' },
{ title: 'Success !', content: 'Your message has been sent successfully.' },
{ title: 'Error !', content: 'A problem has been occurred while submitting your data.' },
{ title: 'Information !', content: 'Please read the comments carefully.' }
];
let toastFlag: number = 0;

let toast: Toast = new Toast({
title: 'Sample Toast Title',
content: 'Sample Toast content'
position: { X: 'Right', Y: 'Bottom' }
beforeOpen: onBeforeOpen
});
toast.appendTo('#element');
toast.show(toasts[toastFlag]);
++toastFlag;

document.getElementById('show_toast').onclick = () => {
  toast.show(toasts[toastFlag]);
  ++toastFlag;
  if (toastFlag === (toasts.length)) {
  toastFlag = 0;
  }
}

function onBeforeOpen(e: ToastBeforeOpenArgs): void {
  if (maxCount === toast.element.childElementCount) {
   e.cancel =true;
  } else {
e.cancel = false;
  }
}

<!DOCTYPE html>
<html lang="en">

<head>
            
    <title>Essential JS 2 Toast</title>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="description" content="Typescript Toolbar Controls" />
    <meta name="author" content="Syncfusion" />
    <link href="index.css" rel="stylesheet" />
    <link href="//cdn.syncfusion.com/ej2/21.1.35/material.css" rel="stylesheet" />
    <script src="https://cdnjs.cloudflare.com/ajax/libs/systemjs/0.19.38/system.js"></script>
    <script src="systemjs.config.js"></script>
</head>

<body>
    <div id='loader'>LOADING....</div>
    <div id='container'>
        <div class='row'> <button class="e-btn" id="show_toast"> Show Toast</button> </div>
        <div id='element'></div>
        <br/><br/>
        <div id='result'></div>
        <div id='templateToast' style="display: none;color:red"> System affected by virus !!! </div>
    </div>
</body>

</html>