Progress Bar

Owned by Content Writers
Last updated: Sept 30, 2024
4 min read

Overview

The Progress Bar component offers a graphical representation of work progress, providing users with a clear visual indication of ongoing operations.

  • Percentage Display: The Progress Bar can be configured to show or hide the percentage of progress. When visible, hovering over the component reveals the current percentage of completion.

  • Visual Representation: It typically displays progress horizontally from left to right, reflecting the status of operations such as file downloads or uploads.

  • Customization: The Progress Bar can be customized to fit the design of your application, including adjusting colors, sizes, and labels.

For example, in a project management dashboard, the Progress Bar component can be used to track the completion status of different project tasks. For instance, if a task involves several steps, the Progress Bar can visually show how many steps have been completed out of the total, helping users easily gauge the overall progress of the task.

image-20240816-104611.png
Progress Bar

Attributes

Attributes are the options available for each component, allowing you to customize its appearance and functionality. They help you tailor the look and behavior of your components to fit your needs.

Basic:

image-20240925-145333.png
Basic

Attribute Name

Description

Attribute Name

Description

Component Size

  • This allows users to modify the size of a specific component according to the grid size of layout.

For example,
If the layout grid size is 3 then layout is divided into 3 sections then you can changes the components size between 1 to 3.

Label

Here you can set the progress Bar name. Generally, the label is displayed at the top left corner

Size

Here you can control the Progress Bars sizes i.e. x-small, small, medium & large.

Value

Here, you can set the progress value for the bar. For example, setting the value to 50 will move the progress indicator to the middle of the bar.

Dest Type

This attribute specifies whether the user wants to store a value in a variable or a model.

  • Variable: If you choose the variable option, you can select the variable where you want to save the field's value. You can bind this variable's value to the component by creating the appropriate variable.

  • Model: Here, you can select "Model" as the value destination.

Note: Value Destination Model field appears when you select "Model" as the Value Destination Type.

Dest Variable

Here you can choose the variable option from this list.

Base UI:

Attribute Name

Description

Attribute Name

Description

Padding Location

Padding Location typically refers to the configuration of spacing around elements

Padding Size

Padding Size refers to the amount of space added inside an element, between the element's content and its border or edge.

Margin Location

Margin Location refers to the spacing around the outside edge of an element

Margin Size

Margin Size refers to the amount of space around the outside edges of an element,

Style

  • It is used to apply custom styles to section, such as color, font, size, and more.

  • It allows you to define the appearance of a component by specifying CSS properties directly within the attribute.

  • You can explore more about Styles attribute

Classes

It is used to apply SLDS classes to section, if needed.

UI:

Attribute Name

Description

Attribute Name

Description

Variant

Change the color of the Progress Bar by below different variants:

Default: Default color is Blue.

Inverse: Change the badge color to Dark Grey.

Success: Change the badge color to Green.

Warning: Change the badge color to Yellow.

Error: Change the badge color to Red.

Show Percentage Checkbox

If you mark this checkbox as true, the percentage will be displayed in the right corner of the progress bar.

Show Rounded Checkbox

Marking this checkbox as true will round the corners of the progress bar.

Show Vertical

By marking this checkbox as true, the progress bar will switch to a vertical orientation.

UI State:

Attribute Name

Description

Visibility Type

It determines whether a component is visible on the layout. It offers the following visibility types:

  1. Always: The component will always be visible.

  2. Conditional: The component's visibility is determined based on specific criteria, which can make it either visible or hidden as needed.
    You can explore more about Visibility Type here.

Events