Progress Bar

This article explains the features of the Progress Bar block and how it can be configured to track the completion of fields in your app.

Use Cases

• Field Inspection Tracker: Monitor the progress of form completion during field inspections by tracking responses to checklist questions.
• Incident Reporting: Track the completion percentage of required fields in incident or accident reports.
• Assessments: Show progress to users completing step-by-step assessments.
• Feedback Forms: Indicate the completion status of survey or feedback questions.

Help Video

Adding the Progress Bar Block

The Progress Bar visually represents the completion status of fields in the app. It dynamically updates based on the user’s inputs and helps provide clarity on how much of the form has been completed.

Editing the Block

Click on the Progress Bar block and start editing on the panel that appears on the right side.

Label

The label is the name of the block that the end user sees in the app.
Example: Progress, Form Completion, or Checklist Progress.

‍

Progress Formula

The Progress Formula defines how the progress is calculated based on the fields in your app. You need to manually configure this formula to calculate progress based on the completion of specific fields. Each field can contribute to the progress, and you can use a formula to set how this is calculated.

How to Create a Progress Formula:

1. Each field in the app that contributes to the progress, typically should have a numeric value. For example, if an app has single selector fields, and a multiline text field:some text
   • Single Selector fields (with Yes/No options): If nothing is selected, the value is treated as 0. If an option is selected, the value is treated as 1.
   • Multi-line Text or Number fields: These fields directly contribute based on whether they are filled in or not. A number that has been input can also be directly taken.
2. Use spreadsheet-like formulas to calculate progress:some text
   • Formula Example:

Let’s take 2 single selector fields and 1 multiline text field
(IF({single sel field 1}="",0,1) + IF({single sel field 2}="",0,1) + IF({multiline text 1}="",0,1))/3
This formula adds up the completed fields and divides the total by the number of fields (in this case, 3) to calculate the percentage progress.

Key Points

• What does the formula do?
  It checks whether a field is empty. If the field is empty, it assigns a value of 0; if the field is filled, it assigns a value of 1.
  For example:some text
  • If “single selector field 1” is left blank, its value is 0.
  • If "Yes" or "No" is selected, its value is 1.
• Why is this necessary?
  The Progress Bar needs a formula to determine how much of the form is completed based on user inputs. You need to define how each field contributes to the progress, using field variables and conditions in the formula.
  You can assign greater or lower values to certain fields depending on your requirements by making use of spreadsheet formulas.

Progress Text

You can configure the Progress Text to display a message below the progress bar.
This field does not accept formulas but allows dynamic text insertion using field variables.

Example: You have completed @progress_value out of @total_value steps.

Advanced Options

Display this field if

Use this option to show or hide the field under specific conditions. It accepts the standard Clappia formulae, similar to conditional sections or in the ‘Calculations & Logic’ block.

1. Type @ to get a list of all the fields you have added in the app and select the relevant field or type @ followed by the field name.
2. Use these field variables to write spreadsheet-like formulae for conditional display of the field in the app.

Example: Show the Progress Bar only if a specific section is reached.

Block Width

• Desktop View: Set the width of the Progress Bar in the desktop view. Options are 100%, 75%, 50%, or 25%.
• Mobile View: Set the width in the mobile view. Options are 100% or 50%.

Variable Name

The Variable Name is the unique identifier for the Progress Bar block, automatically generated upon saving. This can be used in formulas or references within the app.

Example: Field Inspection Tracker

Context of the App

A Field Inspection Tracker app is created for safety inspections in a manufacturing plant. The app includes the following fields:

1. Checklist Questions using Single Selector Blocks: Yes/No options to ensure compliance with safety measures.
2. Multi-Line Text Block: To capture additional notes or actions taken during the inspection.

Fields in the App

1. Single Selectors in the App

Field 1

• Label: Has the equipment been inspected for visible wear or damage?
• Options: Yes/No
• Variable Name (after saving): has_the_eq
  
  Field 2

• Label: Are all safety measures in place and functional?
• Options: Yes/No
• Variable Name (after saving): are_all_sa

2. Multiline text Block in the App

• Label: Actions Taken
• Variable Name (after saving): actions_ta

Progress Bar Configuration

1. Progress Formula:
   (IF({has_the_eq}="",0,1) + IF({are_all_sa}="",0,1) + IF({actions_ta}="",0,1))/3
   
   This formula adds a value of 1 for each completed field and divides the total by 3 to calculate the percentage progress.
   
   

Using the Progress Bar

Once the app is live, the Progress Bar dynamically updates as users fill in the form fields. For example:

• If the user selects "Yes" for one checklist question and fills in the multi-line text, the Progress Bar will display 2/3 completed.

If you'd like to display a custom progress description below the Progress Bar, such as "2 out of 3 completed," you can use the Progress Text option in the Progress Bar’s configuration panel. To dynamically calculate the values for progression, a Calculations & Logic block can be used.

Using the same example, the configurations are as follows:

‘Calculations & Logic’ Block:

Label: Progress Value
Formula:  IF({has_the_eq}="",0,1) + IF({are_all_sa}="",0,1) + IF({actions_ta}="",0,1)
Variable (after saving): progress_v
Advanced option > Hidden: Enabled (This is to ensure that this field is not visible in the main app as it is not relevant for users to see).

Progress Bar: 

Progress Text: {progress_v} out of 3 completed.

In App Home, it will look like the below image.