TABLE OF CONTENTS
The Progress Component allows you to visually represent progress or completion status in your application.
Appearance Settings
The Progress Component includes standard appearance settings, such as size and position, visibility, background, text, padding (for details on standard appearance settings, check the Altering the appearance of an App Studio Component article) and specific styling options for the progress elements: progress background and progress indicator. These settings depend on the selected progress type:
Progress type | Progress background settings | Progress indicator settings |
---|---|---|
Bar | Color Border color Border width Bar style | Color Border color Border width Bar style |
Line | Color Border color Border width Stroke width Line style | Color Border color Border width Stroke width Line style |
Pie | Color Border color Border width | Color |
Donut | Color Stroke width | Color Stroke width Line style |
Configuration Settings
The following settings are available for the Progress Component:
Setting | Description |
---|---|
Value | Set the progress value between 0 and 100. This value determines the progress displayed by the component. |
Type | Select the progress display type: Bar, Line, Pie, or Donut. |
Progress label | Display a label showing the progress percentage or a custom message. You can enhance the label by using mustache expressions. For more details on mustache expressions, refer to Understanding mustaches and expressions. |
Tooltip text | Provide additional information about the progress when users hover over the component. |
Example: Task Completion Tracker
To illustrate the setup of a Progress Component, let’s create a Task Completion Tracker that displays the progress of a project.
To configure the Task Completion Tracker:
- Add the Progress Component onto the canvas.
- Set the Configuration. You can choose between a static or dynamic setup depending on your requirements.
Static configuration: Use this setup when the progress value is fixed or predefined.Value Enter 75 to represent 75% task completion. Type Select Donut for a circular display. Progress Label Enable the label and set it to display 75% Complete. Tooltip Text Enter Project is 75% completed.
Dynamic configuration: Use this setup to display progress that updates in real-time based on project data.Value Use the mustache expression {{completedTasks / totalTasks * 100}}
to calculate the percentage of completed tasks dynamically.Type Select Donut for a circular display. Progress Label Enable the label and set it to display {{completedTasks / totalTasks * 100}}% Complete. Tooltip Text Enter {{completedTasks}} of {{totalTasks}} tasks completed. Customize the Appearance:
Progress Background Set the track color to #E0E0E0 and stroke width to 5. Progress Indicator Settings Set the indicator color to #00ACC1FF, stroke width to 5, and line style to Round.
Add a heading above the Progress Component, such as Project Status, using a Text Component. Include a Button Component labeled View Details to navigate users to more information. The screenshot below shows the Progress Component configured as a Task Completion Tracker.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article