Progress Bar

What the Avonni Progress Bar does

The Progress Bar component displays a task or process's progress. It typically consists of a horizontal bar filled to a certain extent, with the degree of filling representing the completion percentage. The Progress Bar component is often used to provide visual feedback to the user on the status of a task or process.

Changing the properties

What Determines Your Progress Bar's Value?

You have several options for how the progress bar displays its progress:

• Mapped:

  • Directly link the progress bar to a single Salesforce field or variable.

  • This is ideal for simple scenarios where a single value represents progress (e.g., percentage complete, number of tasks finished).

• Advanced (Formula):

  • Create a formula that calculates the progress value by combining multiple fields or variables.

  • This offers more flexibility, allowing you to factor in multiple criteria (e.g., average of multiple scores, weighted progress across different tasks).

• Query:

  • Run a Salesforce query to fetch the progress value directly from your data.

  • This is useful for aggregating data across records (e.g., showing overall project completion based on the status of individual tasks). You can use functions like AVG or MAX within your query.

Example Scenarios

• Sales Goal Progress:

  • Mapped: Link the bar to an "Amount Closed" field.

  • Advanced: Calculate progress based on "Amount Closed" divided by "Quota."

  • Query: Average the "Percent Complete" of all Opportunities in a specific stage.

• Customer Satisfaction:

  • Mapped: Display the value from a "Customer Satisfaction Score" field.

  • Advanced: Combine multiple survey response fields to create a composite score.

  • Query: Find the average rating across all customer reviews for a product.

Choosing the Right Option

The best option for you depends on the complexity of your progress calculation and where your data resides. The Mapped option is quick and easy if you have a simple metric. For more complex calculations, use the Advanced formula builder. A Query provides the most flexibility if your data needs to be aggregated from multiple records.

Choosing a Variant and a Theme

Variant and Theme attributes define the appearance of the Progress Bar indicator. The Variant lets you choose from Base to Circular.

The theme attribute lets you define a specific theme for the Progress Theme. Styling settings for a theme can be overridden by using the Style Panel.

Adding an avatar

Using the attribute, an avatar can be added next to the Progress Bar, either on the left or right side. The avatar can be an icon from the Lightning Design System library or a custom image by uploading a custom image to the Image attribute.

Adding Interactions

No interactions are available.

Customizing Your Progress Bar's Look

The Styles panel lets you tailor your progress bar's appearance to match your design. Here's what you can customize:

• Size: Adjust the overall size of the progress bar (small, medium, large).

• Color Variants:

  • Base: The standard color scheme.

  • Alt Inverse: High-contrast for dark backgrounds.

  • Error: Indicates a problem or failure.

  • Info: Neutral color for informational displays.

  • Inverse: Light bar on a dark background.

  • Offline: Shows when the bar is not actively updating.

  • Success: Represents a positive outcome.

  • Warning: Indicates caution or potential issues.

• Specific Elements:

  • Value: Change the style of the numerical value displayed.

  • Label: Customize the appearance of any text labels.

How to Style Your Progress Bar

1. Open the Styles panel for your progress bar component.

2. Choose the attributes you want to customize.

3. Select your desired colors, fonts, and sizes.

For detailed step-by-step instructions and advanced styling options, refer to our Styling Guide.

Tip: Experiment with different styles to create a progress bar that visually integrates with the rest of your application

How to Apply a Gradient to Your Progress Bar

The Progress Indicator component lets you customize the appearance of your progress bar using gradients. Here's how:

1. Locate the 'Completed color' Setting: Find the "Bar" style section in the Style panel. You'll see the "Completed color" attribute.

2. Apply Your Gradient:

   • Gradient Angle: Choose the direction of your gradient.

   • Gradient Colors: Define the colors you want in your gradient.

   • Color Positions: Indicate where each color should start and stop using percentages (%).

Example: If you want a gradient that transitions from red (0%) to yellow (50%) to green (100%), you will set those colors at their corresponding percentage positions