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 2 Next »

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

image-20240816-103037.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-20240820-075300.png

Attribute Name

Description

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

UI Attributes:

image-20240820-075339.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

image-20240820-110640.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

Disability

image-20240820-110938.png

Attribute Name

Description

Disability Type

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

  1. Never: There is no disable option for this component

  2. Always: The component will always be visible.

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

image-20240820-111135.png

Attribute Name

Description

Component Label

It simply shows the name of the Rating component.

Events

Events available for any component is of onload type.

image-20240818-190902.png

Onload Events:

  • onload event occurs when the component has been loaded.

  • Here, only onload event actions are available for components.

  • Actions are basically workflow actions, which you can explore in Workflow here.

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.