Hey guys, today in this post we are going to learn about how to Create lightning platform show toast event/dispatchEvent where display toast message with hyperlink click button and navigate to external link in Salesforce lightning web component LWC
To trigger a toast from a Lightning web component, in the component’s JavaScript class, import ShowToastEvent from lightning/platformShowToastEvent. Create a ShowToastEvent with a few parameters, and dispatch it. The app handles the rest.
In this example, when a user clicks the button, the app displays a toast with the info variant, which is the default. The toast remains visible for 3 seconds or until the user clicks the close button, denoted by the X in the top right corner, which is also the default. To know more details about Platform Show Toast Event, Click Here.
Parameters of display a toast message →
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 display hyperlink toast in Salesforce LWC →
lwcToastEvent.html | LWc HTML File | Template HTML file to display hyperlink toast in Salesforce Lightning Web Component (LWC) |
lwcToastEvent.js | LWC JavaScript File | It’s hold handleClick action method to display toast messages with link in Salesforce LWC. |
lwcToastEvent.js-meta.xml | XML Meta File | It is used to where this lightning web component file you want to display as lightning__AppPage, lightning__RecordPage, lightning__HomePage. |
Final Output →
You can download file directly from github by Click Here.
Other related post that would you like to learn in Salesforce
- Find the below steps ▾
Create Lightning Web Component HTML →
Step 1:- Create Lightning Web Component : lwcToastEvent.html
SFDX:Lightning Web Component >> New >> lwcToastEvent.html
lwcToastEvent.html [Lightning Web Component HTML]
<template>
<lightning-card>
<div class="slds-m-around_medium">
<h3 class="slds-text-heading_medium"><lightning-icon icon-name="custom:custom90" size="small"></lightning-icon> <strong style="color:#270086; font-size:13px; margin-right:5px;"> Show Toast Event and Navigate to RecordPage in Lightning Web Component (LWC) </strong></h3>
<br/><br/>
<div class="slds-grid slds-wrap">
<div class="slds-col slds-size_6-of-12">
<lightning-button variant="brand" label="Show Toast" onclick={showToast}></lightning-button>
</div>
<div class="slds-col slds-size_6-of-12">
<lightning-button variant="brand" label="Navigate External Link" onclick={handleButtonClick}></lightning-button>
</div>
</div>
<br/>
<br/>
<!--Start RelatedTopics Section-->
<div style="border:1px #ddd solid; padding:10px; background:#eee; margin:40px 0;">
<p data-aura-rendered-by="435:0"><img src="https://www.w3web.net/wp-content/uploads/2021/05/thumbsUpLike.png" width="25" height="25" style="vertical-align:top; margin-right:10px;" data-aura-rendered-by="436:0"><strong data-aura-rendered-by="437:0"><span style="font-size:16px; font-style:italic; display:inline-block; margin-right:5px;">Don't forget to check out:-</span><a href="https://www.w3web.net/" target="_blank" rel="noopener noreferrer" style="text-decoration:none;" data-aura-rendered-by="440:0">An easy way to learn step-by-step online free Salesforce tutorial, To know more Click <span style="color:#ff8000; font-size:18px;" data-aura-rendered-by="442:0">Here..</span></a></strong></p>
<br/><br/>
<p data-aura-rendered-by="435:0"><img src="https://www.w3web.net/wp-content/uploads/2021/07/tickMarkIcon.png" width="25" height="25" style="vertical-align:top; margin-right:10px;" data-aura-rendered-by="436:0"><strong data-aura-rendered-by="437:0"><span style="font-size:17px; font-style:italic; display:inline-block; margin-right:5px; color:rgb(255 128 0);">You May Also Like →</span> </strong></p>
<div style="display:block; overflow:hidden;">
<div style="width: 50%; float:left; display:inline-block">
<ul style="list-style-type: square; font-size: 16px; margin: 0 0 0 54px; padding: 0;">
<li><a href="https://www.w3web.net/lwc-get-set-lightning-checkbox-value/" target="_blank" rel="noopener noreferrer">How to get selected checkbox value in lwc</a></li>
<li><a href="https://www.w3web.net/display-account-related-contacts-in-lwc/" target="_blank" rel="noopener noreferrer">how to display account related contacts based on AccountId in lwc</a></li>
<li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to create lightning datatable row actions in lwc</a></li>
<li><a href="https://www.w3web.net/if-and-else-condition-in-lwc/" target="_blank" rel="noopener noreferrer">how to use if and else condition in lwc</a></li>
<li><a href="https://www.w3web.net/get-selected-radio-button-value-and-checked-default-in-lwc/" target="_blank" rel="noopener noreferrer">how to display selected radio button value in lwc</a></li>
</ul>
</div>
<div style="width: 50%; float:left; display:inline-block">
<ul style="list-style-type: square; font-size: 16px; margin: 0 0 0 54px; padding: 0;">
<li><a href="https://www.w3web.net/display-account-related-contacts-lwc/" target="_blank" rel="noopener noreferrer">display account related contacts based on account name in lwc</a></li>
<li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to insert a record of account Using apex class in LWC</a></li>
<li><a href="https://www.w3web.net/fetch-picklist-values-dynamic-in-lwc/" target="_blank" rel="noopener noreferrer">how to get picklist values dynamically in lwc</a></li>
<li><a href="https://www.w3web.net/edit-save-and-remove-rows-dynamically-in-lightning-component/" target="_blank" rel="noopener noreferrer">how to edit/save row dynamically in lightning component</a></li>
<li><a href="https://www.w3web.net/update-parent-object-from-child/" target="_blank" rel="noopener noreferrer">update parent field from child using apex trigger</a></li>
</ul>
</div>
<div style="clear:both;"></div>
<br/>
<div class="youtubeIcon">
<a href="https://www.youtube.com/channel/UCW62gTen2zniILj9xE6LmOg" target="_blank" rel="noopener noreferrer"><img src="https://www.w3web.net/wp-content/uploads/2021/11/youtubeIcon.png" width="25" height="25" style="vertical-align:top; margin-right:10px;"/> <strong>TechW3web:-</strong> To know more, Use this <span style="color: #ff8000; font-weight: bold;">Link</span> </a>
</div>
</div>
</div>
<!--End RelatedTopics Section-->
</div>
</lightning-card>
</template>
Create Lightning Web Component JavaScript →
Step 2:- Create Lightning Web Component : lwcToastEvent.js
SFDX:Lightning Web Component >> New >> lwcToastEvent.js
lwcToastEvent.js [LWC JavaScript File]
import { LightningElement } from 'lwc';
import { ShowToastEvent } from 'lightning/platformShowToastEvent';
export default class LwcToastEvent extends LightningElement {
showToast() {
const event = new ShowToastEvent({
title: 'Success',
message:'Record created has been successfully',
variant: 'success',
});
this.dispatchEvent(event);
}
handleButtonClick() {
const event = new ShowToastEvent({
title: 'Success!',
message: 'Record {0} created! See it {1}!',
variant: 'success',
messageData: [
'w3web',
{
url: 'https://www.w3web.net/',
label: 'Click Here',
},
],
});
this.dispatchEvent(event);
}
}
Create Lightning Web Component Meta XML →
Step 3:- Create Lightning Web Component : lwcToastEvent.js-meta.xml
SFDX:Lightning Web Component >> New >> lwcToastEvent.js-meta.xml
lwcToastEvent.js-meta.xml [LWC Meta Data XML]
<?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 Salesforce
How do you fire a toast event in LWC?
To trigger a toast from a Lightning web component, in the component's JavaScript class, import ShowToastEvent from lightning/platformShowToastEvent . Create a ShowToastEvent with a few parameters, and dispatch it.
What is toast message in Salesforce?
A toast displays a message below the header at the top of a view. The message is specified by the message attribute. force:showToast is not available on login pages. This example displays a toast message Success!
Which event should be imported to use toast notifications?
Toast Notification is also called Toastify Notifications. This all toast notification comes under-react-toastify module so to use them we need to import this module.
Related Topics | You May Also Like
Our Free Courses →
👉 Get Free Course →
📌 Salesforce Administrators 📌 Salesforce Lightning Flow Builder 📌 Salesforce Record Trigger Flow Builder |
👉 Get Free Course →
📌 Aura Lightning Framework 📌 Lightning Web Component (LWC) 📌 Rest APIs Integration |