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 3 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

Basic 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.

image-20240820-080106.png

Attribute Name

Description

Label

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

Progress Bar Size

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

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.

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.

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.

Value Destination Types

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.

Value Destination Variables

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.

UI Attributes:

image-20240820-080205.png

Attribute Group

Attribute Name

Description

UI

Component Size

  • This allows users to modify the size of a section within the layout according to the grid size.

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

Note: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 .

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.

Visibility

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 attribute

Component

Component Label

It simply shows the name of the Progress Bar component.

Visibility and Component

image-20240820-120634.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 attribute

Component Label

It simply shows the name of the component.

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 Event:

  • 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