Skip to main content

 

 

 

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

Progress Bar

Template:OutSystems/Documentation_KB/ContentCollaboration
  • Edit
    Collaborate with us
    Edit this page on GitHub
  • You can use the Progress Bar to display percentage values by incrementing values in a bar and to show the current progress of a task flow.

    How to use the Progress Bar UI Pattern

    1. In Service Studio, in the Toolbox, search for Progress Bar.

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

    3. On the Properties tab, in the Progress property, enter the progress percentage. In this example we enter 55 but you can also use functions or local variables.

    4. Add the text you want to appear as the Progress Bar title. In this example, we add On Going.

    5. On the Properties tab, you can customize Progress Bar's look and feel by setting any of the optional properties, for example, the shape, color, and size of the Progress Bar.

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

    Properties

    Property Description
    Progress (Integer): Mandatory Percentage displayed on progress bar. You can use integers (usually between 0 and 100), functions, or local variables.
    Color (Color Identifier): Optional Progress bar color. Red, orange, yellow, lime, green, blue, violet, and pink are just some of predefined colors available for the badge.

    Examples

    • Blank - The progress bar color is the color you chose when creating the app (default value).
    • Entities.Color.Red - The progress bar color is red.
    Height (Integer): Optional Progress Bar height (in pixels). The default value is 12.
    AnimateInitialProgress (Boolean): Optional If True, the percentage progress in the progress bar is animated. This is the default. If False, the progress is not animated.
    Text (Text): Optional Deprecated in OutSystems UI.
    Shape (Shape Identifier): Optional Set the Progress Bar shape. The predefined options are:
    • Rounded
    • Soft Rounded
    • Sharp

    Examples

    • Blank - The Progress Bar has a rounded shape (Entities.Shape.Rounded). This is the default.
    • Entities.Shape.Sharp - The Progress Bar has a sharp shape.
    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?