Progress Indicator
Track task progress with visual feedback and clear step indicators.
Overview
The Avonni Progress Indicator component displays a task or process's progress using a visual element. It typically consists of a graphic element indicating the number of steps in a given process, the current step, and the prior steps completed. The Progress Indicator component is often used to provide visual feedback to the user on the status of a task or process.
Tutorials
Name | Description | Illustration |
---|---|---|
Learn how to build a progress indicator that helps users easily navigate through your multi-screen flow. | ||
Create a progress indicator that guides users through your flow, updating automatically as they move between screens. | ||
Learn how to define reusable progress steps for your Avonni Progress Indicators, saving time across multiple screens. | ||
Tim Combridge demonstrates how to create a user-friendly progress indicator within Salesforce Flow using router navigation. | ||
Learn how to control the style of your Avonni progress indicators with a single variable. | ||
How to visually mark errors in specific flow steps with the Progress Indicator's "Has Error" setting, |
Changing the Properties
Indicator Type
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. |
Adding a Data Source
This is where you will connect your Progress Indicator to a Data Source:
Manual
: Input your progress steps directly.Variable
: Connect to an existing data collection and assign specific data points to each step of your Progress Indicator.Picklist
: Your Progress Indicator steps will automatically reflect the values of your chosen picklist field.
Adding a current step
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.
Configuring Completed Steps
You can set the completed steps in two ways:
Manually: Click the "Add item" button and enter either:
The exact text of a step label (if you have fixed steps)
The API name of the Salesforce field that determines progress (if your steps are dynamic)
Dynamically: Use a text collection variable to store an array of the completed steps (e.g., ["Step 1", "Step 2", "Step 3"]). The Progress Indicator will automatically update as items are added or removed from the array.
Adding Interactions
Interactions determine what happens when a user clicks on elements of your progress indicator. Choose from available interactions to customize the experience.
Available Interactions
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
(Vertical Navigation Only): This interaction works specifically when your progress indicator is configured as vertical navigation (steps listed vertically). 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.
Styling the Progress Indicator
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.
Common Attributes
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.
Type-Specific Attributes
Horizontal
Bar: Modifies the appearance of the progress bar itself.
Icon: Style the icons associated with each step (if used).
Step Label: Control the font, text size, color, etc., of step labels.
Vertical
Step Content: Style the area below a step label where additional descriptive text could be displayed.
Sub Step Label: Control the appearance of labels for sub-steps (if applicable).
Bar
Label: Style the text labels for each segment of the bar.
Value: Style how the progress value is displayed (if applicable).
Circle
Circle: Adjust the circle elements' size, color, and outline.
Title: Style the step titles within or near the circle elements.
Path
Size: Adjust the size of the path graphic.
Vertical Navigation
Size: Set the overall width of the vertical navigation bar.
Important: Remember that not all types will have all attributes.
Last updated