Skip to main content

 

 

 

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

Chat Message

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Chat Message UI Pattern to display conversational posts in notifications or chat screens. It can be used to display content such as photos, text, images, delivery times, and statuses.

    How to use the Chat Message UI Pattern

    1. In Service Studio, in the Toolbox, search for Chat Message.

      The Chat Message 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 Chat Message widget into the Main Content area of your application's screen.

      By default, the Chat Message widget contains Image and Content placeholders.

    3. Add the relevant content to the placeholders.

      In this example, we add the user avatar to the Image placeholder and text to the Content placeholder.

      Alternatively, you can use, for example, a List to display a Chat Message for each message record on an entity. You can also use a form to allow users enter their messages. By using the relevant expressions and logic, once the user sends their message, refresh the list of messages so it appears as a conversational post.

    4. You can customize the Chat Message's look and feel by setting the (optional) properties on the Properties tab.

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

    Properties

    Property Description
    DisplayOnRight (Boolean): Optional If True, the pattern is right aligned. If False, the pattern is left aligned. This is the default value.
    Time (Time): Optional Message timestamp.
    MessageStatus (MessageStatus Identifier): Optional The status of the current message, for example, sent recieved, read, and hidden.
    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?