Alert Lightning Web Component ReadMe (Managed Package)

For the managed package runtime, this page contains the Alert LWC ReadMe for each Vlocity release.

Managed Package app icon This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

Vlocity Insurance and Health Spring '20

The Alert Lightning Web Component displays an SLDS or Newport alert.

Available c-alert Attributes

Attribute	Value	Type	Description
theme	slds, nds (Default: slds)	string	Specifies the theme to use.
message		string	Pass simple message into the component. For messages containing markup, use the default slot. If slotted content is passed, `Alert#message` is ignored.
variation	info, warning, error, offline (Default: info)	string	An enum value representing the components style variation.
dismissible	true, false (Default: false)	boolean	If true, the alert can be dismissed by user.
icon		string	The icon name in `spriteName:iconName`format. For example `utility:info`. Pass an empty string to hide. See SLDS icons.

Example c-alert* Component

<c-alert theme="slds"
         variation="info|warning|error|offline"
         icon="utility:trail"
         message="This is a simple message.">
           <span>For more <em>complex</em> messaging, use the default slot.
             <a href="https://lwc.dev/guide/composition#pass-markup-into-slots" target="_blank">Using slots.</a>
           </span>
</c-alert>

Available Custom Labels

Label	ApiName	Description
Close	cmpClose	Assistive text for the icon to close or dismiss the alert.

Available Methods

dismiss()

Dismisses the alert.

Available Classes

Alert

Static class of c-alert component.

Available Events

dismissed

Fires when the alert is dismissed.

Available Variations

enum

Enum for style variations. Is read-only.

Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20