Skip to main content

 

 

 

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

Animate

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Animate UI Pattern to create animations within your app. This UI pattern allows you to emphasize elements as they appear on screen which enhances the overall usability of the app.

    How to use the Animate UI Pattern

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

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

      By default, the Animate widget contains a Content placeholder.

    3. Add the content you want to animate to the Content placeholder.

      In this example, we add an image by dragging the Image widget into the Content placeholder, and on the Properties tab, from the Image dropdown, selecting image from the sample OutSystems UI images.

    4. Select the Animate widget, and on the Properties tab, set the relevant properties, for example, where you want the animation to enter the screen and at what speed.

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

    Properties

    Property Description
    AnimationType (AnimationType Identifier): Mandatory Set how the animation enters the screen.

    The following are the available options:

    • BottomToTop
    • Bounce
    • FadeIn
    • LeftToRight
    • RightToLeft
    • Scale
    • ScaleDown
    • Spinner
    • TopToBottom

    Examples

    • Entities.AnimationType.BottomToTop - Enters from the bottom of the screen to the top of the screen.
    • Entities.AnimationType.Bounce - Bounces onto the screen.
    Delay (Integer): Optional Time to wait before animation starts (in milliseconds). The default value is 0.
    Speed (Speed Identifier): Optional Animation duration. Fast, normal, and slow are the predefined speeds available for the animation.
    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?