Toast
The Toast Construct is used to display brief, non-intrusive notifications to users. Toast messages provide feedback about events or actions, such as success messages, warnings, errors, or general information. They appear temporarily and disappear automatically after a short duration.
Key Features
- To provide real-time feedback on user actions.
- Displays messages without interrupting the user’s workflow.
- It supports success, warning, error, and info messages.
- It can disappear after a specified duration or require manual dismissal.
- To enhance user experience by keeping them informed without requiring manual interaction.
Use Cases:
- Form Submission Feedback: Show success or error messages after form submission.
- User Notifications: Inform users about system updates or actions.
- Error Handling: Display warnings or errors when an issue occurs.
- Action Confirmation: Notify users when an operation is completed successfully.
Toast Severity Levels
| Severity | Description | Use Case |
|---|---|---|
| Success | Indicates a successful action. | Displayed when an operation is completed successfully (e.g., "Data saved successfully"). |
| Information | Provides general information. | Used for non-critical updates (e.g., "New update available"). |
| Warning | Indicates a potential issue that requires attention but is not critical. | Used for cautionary messages (e.g., "Password is about to expire"). |
| Error | Indicates a failure or critical issue that needs immediate attention. | It can be used when an action fails (e.g., "Failed to save data. Please try again!"). |
Toast Construct Properties
| Property | Description | Comments |
|---|---|---|
| Label | Labels help developers quickly understand each step in the logic flow without examining the details of the construct. | It is recommended to provide a simple precise label that improves the logic flow readability. |
| Type* | The severity level of the toast. Select from below list of options: Success Information Warning Error | Determines the styling and priority of the message. |
| Message* | The actual text content displayed in the toast. | Provides feedback to the user. Open the expression builder and you can assign only string types to it. |
| Comment | Specify whether to comment this construct or not. Either Yes or No. | If marked as Yes, the construct is treated as a commented expression and ignored in code generation. |
| Description | A brief explanation of the Toast purpose. | Helps users understand the Toast functionality. |
'Note: ' + ($args[0].Groups[1].Value -replace '\r?\n', ' ')