Hey guys, today in this post we are going to learn about How to How to How to display different types of custom toast message as Error, Success, Info and warning toast message notifications on click button, uses of importing the ‘ShowToastEvent’ property in Javascript in Salesforce Lightning Web Component — LWC.
A lighting component send a toast notification that pops up to alert users of a success, error, or warning. A toast can also simply provide information. To display a toast notification in Lightning Experience or Experience Builder sites, import ShowToastEvent from the lightning/platformShowToastEvent module. Know more about toast notification in lwc
Parameters of toast notification
| PARAMETER | TYPE | DESCRIPTION |
|---|---|---|
| title | String | (Required) The title of the toast, displayed as a heading. |
| message | String | (Required) A string representing the body of the message. It can contain placeholders in the form of {0} … {N}. The placeholders are replaced with the links on messageData. |
| messageData | String[] or Object | url and label values that replace the {index} placeholders in the message string. |
| variant | String | Changes the appearance of the notice. Toasts inherit styling from toasts in the Lightning Design System. Valid values are: info (default), success, warning, and error. |
| mode | String | Determines how persistent the toast is. Valid values are: dismissible (default), remains visible until you click the close button or 3 seconds has elapsed, whichever comes first; pester, remains visible for 3 seconds and disappears automatically. No close button is provided; sticky, remains visible until you click the close button. |
Files we used to create custom toast notification in LWC
| lwcDisplayToastMsg.html | LWc HTML File | Template HTML file to create different types of toast message in lwc |
| lwcDisplayToastMsg.js | LWC JavaScript File | It’s hold a javascript on click function to display the different types Toast Message Notifications using ‘ShowToastEvent’ element lwc. |
| lwcDisplayToastMsg.js-meta.xml | XML Meta File | It is used to where this lightning web component file you want to display as like lightning__AppPage, lightning__RecordPage, lightning__HomePage. |
Final Output
Other related post that would you like to learn in LWC
- Find the below steps
Create Lightning Web Component HTML
Step 1:- Create Lightning Web Component HTML ➡ lwcDisplayToastMsg.html
SFDX:Lightning Web Component ➡ New ➡ lwcDisplayToastMsg.html
lwcDisplayToastMsg.html [Lightning Web Component HTML]
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
<template> <lightning-card> <div class="slds slds-p-around--medium"> <h3 class="slds-text-heading_medium"><lightning-icon icon-name="custom:custom20" size="small"></lightning-icon> <strong style="color:#270086; font-size:13px;"> Display Toast Notifications in Lightning Web Component (LWC) </strong></h3> <br/><br/> <table class="slds-table slds-table_header-fixed slds-table_bordered slds-table_edit slds-table_resizable-cols" cellspacing="0" cellpadding="0" style="border-collapse:collapse; border:1px #ddd solid;"> <tbody> <tr> <td style="width:30%; border-right:1px #ddd solid;"><lightning-button variant="destructive " label="Show Error" onclick={displayToastError}></lightning-button> </td> <td style="width:70%; color:rgba(214, 5, 1, 1); font-weight:bold;">Display Error Toast Message Notifications</td> </tr> <tr> <td style="width:30%; border-right:1px #ddd solid;"><lightning-button variant="brand" label="Show Warning" onclick={displayToastWarning}></lightning-button></td> <td style="width:70%; color:rgb(243 114 4); font-weight:bold;">Display Warning Toast Message Notifications</td> </tr> <tr> <td style="width:30%; border-right:1px #ddd solid;"><lightning-button variant="success" label="Show Success" onclick={displayToastSuccess}></lightning-button></td> <td style="width:70%; color:rgb(21 136 0); font-weight:bold;">Display Success Toast Message Notifications</td> </tr> <tr> <td style="width:30%; border-right:1px #ddd solid;"><lightning-button variant="brand" label="Show Info" onclick={displayToastInfo}></lightning-button></td> <td style="width:70%; color:rgb(212 205 0); font-weight:bold;">Display Info Toast Message Notifications</td> </tr> </tbody> </table> <br/><br/> <p>To know more <strong>live demo</strong> in LWC, Use this <strong><a href="https://www.w3web.net/tutorial/salesforce-lwc/" target="_blank" rel="noopener noreferrer">link..</a></strong></p> </div> <br/><br/> <p><img src="https://www.w3web.net/wp-content/uploads/2021/05/thumbsUpLike.png" width="25" height="25" style="vertical-align:top; margin-right:10px;"/> <strong> <span style="font-size:15px; font-style:italic; display:inline-block; margin-right:5px;">Don't forget to check out:-</span> <a href="https://www.w3web.net/" target="_blank" style="text-decoration:none;" rel="noopener noreferrer">An easy way to learn step-by-step online free tutorial, To know more Click <span style="color:#ff8000; font-size:18px;">Here..</span></a></strong></p> </lightning-card> </template> </lightning-card> </template> |
Create Lightning Web Component Javascript
Step 2:- Create Lightning Web Component Javascript ➡ lwcDisplayToastMsg.js
SFDX:Lightning Web Component ➡ New ➡ lwcDisplayToastMsg.js
lwcDisplayToastMsg.js [LWC JavaScript File]
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
import { LightningElement } from 'lwc'; import { ShowToastEvent } from 'lightning/platformShowToastEvent'; export default class LwcDisplayToastMsg extends LightningElement { displayToastError() { const toastEvt = new ShowToastEvent({ title: 'Error', message: 'Some Error Occurred', variant: 'error', mode: 'dismissable' }); this.dispatchEvent(toastEvt); } displayToastSuccess() { const toastEvt = new ShowToastEvent({ title: 'Success', message: 'Submitted Successfully ', variant: 'success', mode: 'dismissable' }); this.dispatchEvent(toastEvt); } displayToastWarning() { const toastEvt = new ShowToastEvent({ title: 'Toast Warning', message: 'Some Problem Occurred', variant: 'warning', mode: 'dismissable' }); this.dispatchEvent(toastEvt); } displayToastInfo() { const toastEvt = new ShowToastEvent({ title: 'Toast Info', message: 'Data running in background', variant: 'info', mode: 'dismissable' }); this.dispatchEvent(toastEvt); } } |
Create Lightning Web Component Meta XML
Step 3:- Create Lightning Web Component Meta XML ➡ lwcDisplayToastMsg.js-meta.xml
SFDX:Lightning Web Component ➡ New >> lwcDisplayToastMsg.js-meta.xml
lwcDisplayToastMsg.js-meta.xml [LWC Meta Data XML]
|
1 2 3 4 5 6 7 8 9 10 |
<?xml version="1.0" encoding="UTF-8"?> <LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata"> <apiVersion>45.0</apiVersion> <isExposed>true</isExposed> <targets> <target>lightning__AppPage</target> <target>lightning__RecordPage</target> <target>lightning__HomePage</target> </targets> </LightningComponentBundle> |
Further post that would you like to learn in LWC
If you think you and your family members also like to earn money in additional time, then go this link. In this site, you can earn money for the lifetime at low effort. To Earn Unlimited Everyday With This Trick, Sign Up Free.. Get Started for Free
Check Out:- Earn Unlimited Everyday With This Trick:- Click Here
Related Topics | You May Also Like
How to get/set checkbox value in lwc component and display the selected value using of “lightning-checkbox-group” property in Lightning Web Component (LWC) Salesforce | how to get selected checkbox value in lwc
LWC to Get Logged in User Id, Name, Email, IsActive, Alias details without apex class Uses of ‘uiRecordApi’ property and display the current User detail on lightning component in Salesforce Lightning Web Component (LWC) | How to get current user detail in lwc
How to create a custom form validation and display required Error message upon handle input change in Lightning web component – LWC | create a custom form validation in lwc
Retrieve picklist values dynamically of Opportunity Object without apex class using ‘uiObjectInfoApi’ property and displaying the selected pick-list value in Salesforce Lightning Component — LWC | How to fetch picklist value without apex method and display selected pick-list value in lwc
How to display account related contacts based on account name using search input and click button in Salesforce lightning web component – LWC | display account related contacts based on account name in lwc
How to display account related contacts based on AccountId using the CustomEvent & dispatchEven in Salesforce lightning web component – LWC | how to display account related contacts based on AccountId in lwc
Create range slider positioned horizontally and vertically between two specific numbers and get the slider value using the event.detail property in Lightning Web Component — LWC | how to get range slider value in lwc salesforce
How to Insert, Edit/Update record without apex class by help of the lightning data service using “lightning-record-form” in Lighting Web Component — LWC | Insert record lightning data service in lwc
Author of w3web.net
Hi, This is Vijay behind the admin and founder of w3web.net. I am a senior software developer and working in MNC company from more than 8 years. I am great fan of technology, configuration, customization & development. Apart of this, I love to write about Blogging in spare time, Working on Mobile & Web application development, Salesforce lightning, Salesforce LWC and Salesforce Integration development in full time.