Overview

Rating component is used to collect and display user feedback in the form of star ratings. This component allows users to rate items, such as products, services, or features, providing valuable insights and feedback.

For example, in a product review section of an e-commerce application, the Rating component can be used to display user feedback on products. Customers can rate their purchased items from 1 to 5 stars, and the average rating will be shown alongside the product details to help other users make informed decisions

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	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.
Display As	Display As allows you to select data type options to define how the field will be display. For example, if you have a text field and choose to display it as a picklist, the data will be stored as text but displayed as a picklist
Label	Here user can add label name for Rating. User can also select label name from different value source Reference: Merge Text Config
Placeholder	A placeholder is a temporary value or text displayed in an input field.
Type	Here user can select the different data type.
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 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.
Size	You can adjust the rating size to XX-Small, X-Small, Small, Medium, or Large.

Validation:

Attribute Name

Description

Required Type

You can make the field required by setting the required type.
Here user can select the required type as

Always: The field is always required.
Never: The field is never required.
Conditional Filter: The field is required only if specific conditions are met.

Required Error

Users can add a custom error message for the required field.

Base UI:

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.
Hide Space	The `Hide Space` checkbox removes any empty or extra space around the element when selected.

UI State:

Attribute Name	Description
Visibility Type	It determines whether a component is visible on the layout. It offers the following visibility types: Always: The component will always be visible. 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 Reference: Conditional Visibility
Read Only Type	It specifies whether a component can be edited by users. It offers the following options: Never: The component will always be editable at any time. Always: The component will never be editable. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed. You can explore more about conditional visibility Reference: Read Only.
Disability Type	It determines whether a component is disable on the layout. It offers the following visibility types: Never: There is no disable option for this component Always: The component will always be visible. 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. Reference: Conditional Disability

UI:

Attribute Name	Description
Layout	Field Layout allows you to arrange fields on the form. For more details check this Reference: Layout
Is Copy Enabled	After marking the checkbox as true, a copy icon will appear beside the name field.
Help Text	Provides additional guidance or information about a field or element to assist users in understanding how to complete it or what data is expected.

Layout:

Attributes	Description
None	In the None layout, only the input/output field is visible, with no label displayed.
Stacked	In a stacked layout, the input/output field is placed below the field label, with a small margin around the label.
Horizontal	In a horizontal arrangement, the input/output field is placed before the field label, with a small margin around the label.
Single Column	In a Single Column layout, the input/output field is larger than the field label, and displayed in single column grid.
No Label	In the No Label layout, only the input/output field is visible, without the label.

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: Mobile Desktop Tablet

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

Never: The component will always be editable at any time.
Always: The component will never be editable.
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

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:

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, we have onload event, click event actions are available for this components.

Icon Events	Description
onload	This event action is triggered when the Rating component is loaded.
click	This event action is triggered when the Rating component is clicked.

Note: Similarly you can create event action for click.

on Load Event:

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 `Destination Type` is set as `Model`.
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 `Source Type` is set as `Static`.
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 `Cookie Key`, the result is fetched by the value that has been added under the Cookie Key. But, have to make sure that the value that we are adding is from the Cookie Key value.
Local Storage Key	By using the `Local Storage Key`, the result is fetched by the value that has been added under the Local Storage Key. But, have to make sure that the value that we are adding is from the Local storage value.

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 `Source`.
Output Variable	Select from the output variables created in the layout whose value you want to use as `Source`.
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 `First Name` field from the user, each time a different user logs in, they will see their own First Name displayed.
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.