Progress Indicator
Track task progress with visual feedback and clear step indicators.
Last updated
Track task progress with visual feedback and clear step indicators.
Last updated
The Avonni Progress Indicator visually shows how far along a task or process is. It usually looks like a bar or a series of steps, highlighting the current step and any completed steps. This helps users understand where they are in a process and what's left to do.
You can create progress indicators with different visual styling by specifying the type attribute.
| Type | Description | Illustration |
|---|---|---|
Horizontal | Shows progress through a left-to-right sequence, guiding users through tasks or stages efficiently. | |
Vertical | Designed to track the progression of tasks or processes in a top-to-bottom layout. | |
Bar | Shows task completion as a horizontal fill within a bar, increasing as progress towards the goal advances. | |
Circle | Visually tracks task completion in a circular path, filling or highlighting as progress is made. | |
Path | Each step is denoted by a distinct marker, reflecting the flow of the process. | |
Vertical Navigation | Marks progress through steps in a top-to-bottom layout, visually guiding users through stages or tasks. |
This is where you link your Progress Indicator to the information it will display:
Manual: Type in the steps of your progress indicator yourself.
Variable: Connect to an existing data collection in your flow and choose which data points to show at each step.
Picklist: The steps in your progress indicator will automatically match the values in the picklist field you select from Salesforce
The Avonni progress indicator component helps users visualize their progress by highlighting the current step through a screen flow. You can define the current step in two ways:
1. Manual Value
This approach is ideal if the order of steps is fixed and doesn't change based on user input.
Data Source: You have a list of steps defined somewhere (this is your data source). Each step has a "value" attribute, essentially its unique name or identifier.
current-step Attribute: In the Avonni progress indicator component settings, locate the current-step attribute. Set this attribute to the specific "value" of the step you want to highlight as current.
Example:
Let's say you have a three-step flow for onboarding a new user:
Step 1: "Sign Up" (value attribute: "signup")
Step 2: "Verification" (value attribute: "verification")
Step 3: "Welcome" (value attribute: "welcome")
If the user is currently on the "Verification" step, you would set the current-step attribute of your progress indicator component to "verification".
2. Flow Variable
This method is useful when the current step might change dynamically based on user choices or flow logic.
Flow Variable: Create a text variable in your flow to store the value corresponding to the current step (e.g., a text variable called "currentStep"). Update this variable within your flow as the user progresses through the steps.
current-step Attribute: In the Avonni progress indicator component settings, instead of entering a specific value for the current-step attribute, reference your flow variable using curly braces and an exclamation mark (e.g., {!currentStep}).
Benefits of Flow Variables
Dynamic Updates: The progress indicator automatically reflects the current flow position based on your variable's value.
Flexibility: This approach is adaptable to changing flow logic or step order.
Choosing the Right Method
Use a manual value when the steps are fixed and predictable.
Use a flow variable for adaptability or when the current step depends on user input.
You can show which steps are completed in two ways:
Click "Add item."
If your steps are fixed (always the same), type in the exact text of the step label.
If your steps change based on data, type in the API name of the Salesforce field that tracks progress.
Use a text collection variable to store a list of the completed steps (e.g., ["Step 1", "Step 2", "Step 3"]).
The Progress Indicator will update automatically as items are added or removed from this list.
Interactions determine what happens when a user clicks on elements of your progress indicator. Choose from available interactions to customize the experience.
On Step Click: This event triggers when the user clicks on a step within the progress indicator. You could use this to:
Navigate to the corresponding section in your flow.
Display additional information about that step.
Open a modal or pop-up with more options.
On Step Action Click: It allows you to define actions when the user clicks on a specific action associated with a step (if you've added any).
Refer to this page for a complete list of supported interactions and learn how to configure them.
You can adjust the following attributes to customize the appearance of your progress indicator.
The options available will depend on the progress indicator type you've chosen.
Margin: Controls the spacing around the outside of the entire progress indicator component.
Padding: Sets the space between the component's border and internal elements.
Border: Customize the border's appearance (style, width, color).
Container: Style the overall box that holds the progress indicator elements
