Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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

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

Attribute Name

Description

Component Size

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

  • This feature allows for flexible customization, enabling users to resize components to fit their specific needs within the defined grid structure.

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 Var

Here you can choose the variable option from this list.

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

Value Destination Model

  • From the value destination model, you can select the specific model where you want to save the field's value.

  • By using a model, you can bind a value to the component, with the value coming from the object used during model creation.

Base UI:

image-20240925-145513.png

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:

image-20240925-145628.png

Attribute Name

Description

Variant

Variant Change the color of the Progress Bar. below are the 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:

image-20240925-145824.png

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.

Conditional Visibility Type:

image-20240814-092607.png

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:

  1. Mobile

  2. Desktop

  3. Tablet

Conditional Disability Type:

image-20240814-093021.png

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.
Reference: Available Sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Conditional Read Only:

image-20240823-064414.png

Attribute Name

Description

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed.

Add Condition & Group Condition

image (21)-20240822-182312.png

Condition

Description

Add Condition

  • The Add Condition feature allows users to define multiple criteria that must be met for a validation rule to trigger.

  • This feature is used to create complex logic by combining different conditions that Salesforce evaluates before allowing a record to be saved.

Add Group Condition

  • The Add Group Condition feature allows users to group multiple conditions together, creating complex logic that involves different sets of criteria.

  • This feature is particularly useful when combining conditions that should be evaluated as a unit (logical OR within a group) or when nesting conditions for more advanced logic.

Filter Operator:

Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type

Filters Attributes:

image-20240822-134925.png

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.

image-20240822-091137.png

In the image below, you can select the created workflows.

image-20240822-084758.png

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

image-20240822-091307.png

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.

image-20240822-093156.png

  • No labels