Skip to main content

 

 

 

 
Language:
 
Applies only to Mobile Apps and Reactive Web Apps
Service Studio version:
 
 
OutSystems

Alert

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Alert UI Pattern to highlight and display important information, errors, or warnings.

    How to use the Alert UI Pattern

    1. In Service Studio, in the Toolbox, search for Alert.

      The Alert widget is displayed.

      If the UI widget does not display, it may be because you used a ready-made app, which deletes unused widgets from the module. To make additional widgets available in your app:

      a. Go to Module > Manage dependencies.

      b. Search for and select the relevant Producer, for example OutSystemsUI. Ensure Show All is selected.

      c. On the Public elements for the selected Producer displayed on the right, ensure Show All is selected.

      d. Search for and select the element you want to add, and click Apply.

      e. In Service Studio, in the Toolbox, search for the widget again.

    2. From the Toolbox, drag the Alert widget into the Main Content area of your application's screen.

    3. Select the MessageText placeholder, and enter the Alert message you want to display.

    4. On the Property tab, set the AlertType property. In this example, the alert type is set to error which changes the message to display in red.

    After following these steps and publishing the module, you can test the pattern in your app.

    Properties

    Property Description
    AlertType (Alert Identifer): Mandatory Select the type of alert. the predefined options are:

    • Error
    • Info
    • Success
    • Warning

    Examples

    • Entities.Alert.Warning - Displays a yellow warning message.
    • Entities.Alert.Info - Displays a blue information message.
    ExtendedClass (Text): Optional Adds custom style classes to the Pattern. You define your custom style classes in your application using CSS.

    Examples

    • Blank No custom styles are added (default value).
    • "myclass" Adds the myclass style to the UI styles being applied.
    • "myclass1 myclass2" - Adds the myclass1 and myclass2 styles to the UI styles being applied.
    You can also use the classes available on the OutSystems UI. For more information, see the OutSystems UI Live Style Guide.
    • Was this article helpful?