AX - Progress Indicator
Overview
AX - Progress Indicator is a Lightning App Builder component that displays process stages as a visual step tracker based on picklist field values on record, app, and home pages.
Use it to show users where records are in a workflow—like sales stages, case statuses, project phases, or approval processes. Users can click steps to update the record's status, with options for linear progression (steps must be completed in order) or non-linear (jump to any step). Choose from horizontal, vertical, or Salesforce Path-style layouts.
Perfect for guided workflows, status tracking, onboarding processes, or anywhere users need visual clarity on where a record stands in a multi-step process.
Getting Started
Use this simple tutorial to learn the basics of the Progress Indicator component and start building your use cases.
Key features
Data Integration: Builds its steps directly from the values of any picklist field on any Salesforce object.
Flexible Layouts: Choose horizontal, vertical, or Salesforce Path-style display.
Progress Modes: Linear (prior steps show as completed) or non-linear (only the current step is highlighted).
Interactivity: Optionally let users click a step to update the record's picklist value.
Customization: Force specific values to show as completed, hide irrelevant values, and add a header with title, caption, and icon.
Use Cases
Sales Process Management
Track opportunity progression through sales stages on Opportunity pages
Display lead qualification steps with interactive stage updates
Show quote approval processes with visual milestone tracking
Service & Case Management
Visualize case resolution stages from creation to closure
Track service request workflows with interactive status updates
Display escalation processes with clear progression indicators
Project & Task Management
Show project phase progression with milestone completion tracking
Display task workflows from assignment to completion
Track approval processes with visual stage indicators
Configuration
Properties
Object API Name
String
—
Yes
API name of the Salesforce object used to retrieve records.
Picklist Field Name
String
—
Yes
API name of the picklist field used to generate the steps in the progress indicator.
Record Id
String
—
The record ID to use. Leave this empty to use the current record page.
Completed Values
String
—
Comma-separated list of picklist values that should be shown as completed in the progress indicator, regardless of the current value.
Hidden Values
String
—
Comma-separated list of picklist values that should be excluded from the progress indicator and not displayed to the user.
Type
String
path
Defines the display layout of the progress indicator. Valid values include horizontal, vertical, and path. Default is horizontal. Options: horizontal, vertical, path.
Format
String
linear
Defines the visual behavior of completed steps. linear shows previous steps as completed, while non-linear highlights only the current step. Default is linear. Options: linear, non-linear.
Display as Card
Boolean
true
If true, displays the image inside a styled card container for better presentation in dashboards or record pages.
Clickable
Boolean
false
If true, makes each step clickable and updates the record's picklist field value upon selection.
Header - Title
String
—
Text displayed as the main title in the component's header. Example: “Open Opportunities” or “Top Accounts.”
Header - Caption
String
—
Subheading text displayed below the header title to provide extra context. Example: “Sorted by Stage” or “Filtered by Priority.”
Header - Icon Name
String
—
SLDS icon name (e.g., standard:account) displayed next to the header title. Example: standard:contact for a contact list.
Use Case Examples
Example 1: Case Resolution Workflow
Scenario: Track case status progression with vertical layout and non-linear completion tracking for service agent workflow management.
Steps
Result: A vertical case status tracker positioned in the sidebar with non-linear progression highlighting, perfect for service agent workflows where only the current status needs emphasis
Example 2: Track an opportunity approval process
Scenario: Track an ongoing approval process for high value opportunities
Prerequisite
Create an
Approval_Status__ccustom picklist on the Opportunity object to track approval with valuesNone/Pending/Approved/Rejected
Steps
Key Considerations
Process Design: Choose picklist fields that represent clear, sequential steps, set meaningful completed values, and hide irrelevant or negative outcomes.
Visual Layout: Use Path type for sales processes, vertical layout for sidebars or narrow containers, and horizontal layout for main content areas.
User Interaction: Enable clickable functionality to let users update stages; use linear format for sequential processes and non-linear when only the current step matters.
Performance: Keep picklist value lists short for visual clarity, test responsive behavior, and mind frequent field updates when clickable is enabled.
Troubleshooting Common Issues
Progress Indicator Not Appearing: Verify the Object API Name and Picklist Field Name exist and are accessible, and that the record holds valid picklist values.
Steps Showing Incorrectly: Confirm completed and hidden value lists are comma-separated and match the picklist values exactly (case-sensitive).
Clicking Not Working: Enable Clickable, confirm edit permission on the picklist field, and ensure the record is not locked or read-only.
Layout Issues: Try different Type settings, check that header text length suits the layout, and use Display as Card for separation; test on mobile.
Format Behavior Problems: Understand linear (progressive) vs. non-linear (current only) formats and align your completed-values configuration with the chosen format.
Last updated
Was this helpful?
