Skip to content

schandlergarcia/lightning-messaging-utility

Repository files navigation

Lightning Messaging Utility(AppExchange)

Whether you're a Salesforce Admin or Developer - the way you deliver messages to your users is key to building a user-friendly app! Lighting Messaging Utility gives you the tools you need to build clean and consistent messages at all times!

Lightning Messaging Utility gives you the ability to drag and drop messaging components into the lighting app builder as well as using them programmatically to speed up development!

overview

Video Overview

Lightning Design System Messaging Guidelines

Always reference the Lightning Design System Messaging Guidelines when using this component: https://www.lightningdesignsystem.com/guidelines/messaging/overview/#site-main-content

Installation

Clone the Lightning Messaging Utility repository and push to your org

git clone https://github.com/schandlergarcia/lightning-messaging-utility
cd lightning-messaging-utility
sfdx force:source:push -u <org username>

Code Samples

This component was designed to give you an easy to use some of the SLDS messaging types in your Lightning Web Components, the full documentation can be found on the AppExchange.

1) Alert

    <c-lwc-messaging-utility message-type="alert"
                             message-title="Error Connecting to the Streaming API"
                             message-variant="error"
                             show-icon=true
                             icon-name="utility:error"
                             icon-alternative-text="An error has occurred"
                             icon-size="small"
                             icon-variant="error"
                             allow-close=true
                             max-width="100"
                             showMessage="true">
    </c-lwc-messaging-utility>

Alert components

2) Inline Text

    <c-lwc-messaging-utility message-type="inline"
                             message-title="Warning"
                             message-body="This person can not be contacted"
                             message-variant="warning"
                             show-icon=true
                             icon-name="utility:warning"
                             icon-alternative-text="warning"
                             icon-size="small"
                             icon-variant="warning"
                             max-width="100"
                             showMessage="true">
    </c-lwc-messaging-utility>

Inline text components

3) Illustration

    <c-lwc-messaging-utility message-type="illustration"
                             message-title="Warning"
                             message-body="This person can not be contacted"
                             illustration-name="empty"
                             max-width="100"
                             showMessage="true">
    </c-lwc-messaging-utility>

Illustrations

4) Prompt

    <c-lwc-messaging-utility message-type="prompt"
                             message-title="Annual Maintenance"
                             message-body="We will be going under annual maintenance on..."
                             message-variant="info"
                             show-icon=true
                             icon-name="utility:info"
                             icon-alternative-text="info"
                             icon-variant="warning"
                             max-width="100"
                             button-label="OK"
                             showMessage="true">
    </c-lwc-messaging-utility>

Inline text components

About

This component was built for Salesforce Labs and was created and maintained by Andrew Paterson and Stephan Chandler-Garcia

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published