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.
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:
Attribute Name | Description |
---|---|
Component Size |
For example, if the layout grid size is |
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.
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. Note: This field appears when you select "Variable" as the Value Destination Type. |
Base UI:
Attribute Name | Description |
---|---|
Padding Location |
|
Padding Size |
|
Margin Location |
|
Margin Size |
|
Style |
|
Classes | It is used to apply SLDS classes to section, if needed. |
UI:
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:
Reference: Conditional visibility |
Conditional Visibility Type:
Attributes Name | Description |
---|---|
Destination Type | Users can select the destination type where the visibility criteria must be applied. Reference: Destination Type |
Operator | Here, users can select different operators to add filters. Reference: Filter Operator. |
Source Type | Here, you can select the source type from various sources. |
Value | Here user can select the value from different Source Type. Reference: Merge Text |
Destination Type
Destination Type | Description |
---|---|
Model | From this source, users can select a Model field to be displayed as the destination type. |
Variable | Here, users can select the destination type from variables such as Record ID, Is Disabled, Is Read only, or Is Visible. |
User | Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID. |
Record | It enables to choose record fields as destination type. |
Device | It enables user to decide whether the action will be visible on the specific device type or not. Devices supported:
|
Conditional Disability Type:
Attributes Name | Description |
---|---|
Destination Type | Users can select the destination type from various sources. Reference: Destination Type |
Operator | Here, users can select different operators to add filters. Reference: Filter Operator. |
Source Type | Here, you can select the source type from various sources. |
Value | Here user can select the value from different Source Type. Reference: Merge Text |
Conditional Read Only:
Attribute Name | Description |
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Add Condition & Group Condition
Condition | Description |
---|---|
Add Condition |
|
Add Group Condition |
|
Filter Operator:
Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type
Filters Attributes:
Filter Operators
Operator | Supported Field Types | Description |
---|---|---|
Equal | Number, Currency, Date, Text, Boolean, Picklist | The equal operator is used to compare two values or expressions. It is used to compare numbers, strings, Boolean values, variables, objects, etc. The result is TRUE if the expressions are equal otherwise it’s FALSE |
Contains | Text, Picklist | The contains operator returns TRUE if the value on the left contains the value on the right, and otherwise FALSE |
Starts With | Text, Picklist | It returns TRUE if a string or number starts with the specified character otherwise it returns FALSE. |
Ends With | Text, Picklist | It returns TRUE if a string or number ends with the specified character otherwise it returns FALSE |
In | Text, Picklist | IN operator allows you to easily test if the expression matches any value in the list of values. Determines whether the value of an expression is equal to any of several values in a specified list. |
Events
Events are essentially the automation of invoking the component's actions.
Here, only onload event actions are available for this components.
In the image below, you can select the created workflows.
Note: You need to create a workflow for selecting from this list.
For more information about Workflow check this out.
Reference: Workflow
onload Events:
We have an onload event that runs when the component is loaded.
For example, when a form is loaded, you can choose fields to be prepopulated by mapping field values using input mapping at the time the form component is loaded.
Input Mapping
Whenever an event is triggered and you want to pass data to destinations such as models, variables, or components, you can use input mapping to achieve that.
After clicking on Pencil
icon, user can view the screen to set Input Mapping
as follows:
After clicking on +
button, user can set up input mapping using Input Mapping
Screen as follows:
Condition | Description |
---|---|
Destination Type | It specifies the destination where the connector mapping is to be done. Reference: Destination Type Note: By default, the |
Model | It is specifically dependent on Destination Type one chooses. If you choose another Destination Type, you will get that field label here. |
Note: Fields below this will only be enabled once user filled above two fields. | |
Field | After choosing the second condition field, you will get this field visible in modal. If you chose Model as second condition field, this will be field and if you chose variable as second field, there will be variable. |
Operator | It is specifically operator value such as Set, Equals, Greater than, Equals than. |
Source Type | In this option, you can select various sources from which you want to display values. Reference: Source Type Note: By default, the |
Value | The available options will change depending on the selected source type. For example, if you choose "Static" as the source, you can provide a fixed static value. |
Destination Type
Label Source Type Attribute | Description |
---|---|
Model | From this source, users can select a Model field to be displayed as the label name. |
Variable | Here, users can select the label name from variables such as Record ID, Is Disabled, Is Read only, or Is Visible. |
Input Variable | Here, users can select the input variable which they have created earlier. |
Cookie key | By using the |
Local Storage Key | By using the |
Source Type
Source Type | Description |
---|---|
Static | Use this option to provide a fixed static value. |
Field | Select the field from the chosen object in the model whose value you want to include. |
Model | Choose the field from other models whose value you want to include. |
Variable | Select from the variables created in the layout whose value you want to use as |
Output Variable | Select from the output variables created in the layout whose value you want to use as |
Cookie Key | Choose the available cookie key whose value you want to include from your browser. |
Local Storage Key | Select the available Local Storage Key whose value you want to include from your browser. |
User | You can also select fields from the current logged-in user in your organization to include in the merge. Note: The User source refers to the currently logged-in user in your organization. This means that if you include the |
Null | It enables assign null value to the Destination Type field we chose. |
Blank | It enables assign blank value to the Destination Type field we chose. |
Add Comment