Overview
The Form component serves as a container for capturing user input. To utilize its functionality, you must associate the Form with a model (Salesforce Object). Once linked, the fields from the selected object will appear on the left side of the interface. You can then drag and drop these fields into the Form, where they will be displayed for user interaction.
Additionally, you can add multiple actions to the Form, such as buttons. One of these actions can be designated as the primary action, allowing you to define the main function or submission behavior of the Form.
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.
Attribute Name | Description |
|---|---|
Model | All the Models (Salesforce Object) you have created will appear in the list. You can select a specific model from the list to save and display its field values. Note: Only one model (Record Type - Single) can be bound at a time. |
Field Layout | Field Layout allows you to arrange fields on the form. Reference: Field Layout |
No Action Bar | If the “No Action Bar” checkbox is selected, the action bar will be hidden on the form. |
Action | You can include multiple actions, each displayed as a button. Clicking a button initiates a specific action or workflow. Note: After creating the action, it will be displayed on the canvas. Reference: Create Form Action Configuration |
Primary Actions | You can select a primary action from the available options. Pressing the Enter key will execute this primary action. |
Overflow After | This feature allows you to control the number of actions displayed. Setting the limit to 1 will show only one action, with additional actions appearing in a drop-down menu. |
UI Attributes:
Attribute Name | Description |
Component Size |
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 |
|
Classes |
|
Layout Type | It is used to set the layout type in two ways as:
Note: By default, this attribute is set to a value of Grid Layout Type. You can explore more about Layout Type attribute. |
Grid Size | This feature allows you to display elements inside the tab. If you choose a grid size of 2, the elements will be arranged in two sections. |
Hide space checkbox | When marked as true, this option removes the space between fields within the form component. |
Visibility
Attribute Name | Description |
|---|---|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Read Only
Attribute Name | Description |
|---|---|
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Disability
Attribute Name | Description |
|---|---|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
Component
Attribute Name | Description |
|---|---|
Component Label | It simply shows the name of the Rating component. |
Field Layout Configuration
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, unlike in a horizontal layout. |
No Label | In the No Label layout, only the input/output field is visible, without the label. |
Actions
Attributes | Description |
|---|---|
Label | A Label is the name shown to users and can come from various sources. Reference: Source Type |
Name | Enter a unique the name for your action. |
Icon | This option lets you choose from various icons to add to the action button. |
Variant | This feature allows users to change the appearance of the action button.
|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
Label Source Type:
Attribute | Description |
|---|---|
Model (Salesforce Object) | From this source, users can select a Model (Salesforce Object) 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. Reference: Variable |
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 | Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID. |
Merge Field Expression | Merge Field Expression displays the value selected from the chosen value source. |
Message Body | Inside the message body, user also can add the values manually. |
Note: After adding fields to the form, you can configure specific fields. The table below shows all available attributes.
Form Fields Attributes:
Basic Attributes:
Attribute Name | Description |
|---|---|
Label | A Label is the name shown to users and can come from various sources. Reference: Source Type |
Place holder | This is a hint or example text displayed in an input field before the user enters their own data. |
Layout | Field Layout allows you to arrange fields on the form. Reference: Field Layout |
Hide Space Checkbox | After marking this checkbox as true, it will crop the extra corners of the fields. |
Config And UI Attributes:
Attribute Group | Attribute Name | Description |
|---|---|---|
Config | Debounce time in seconds | "Debounce time in seconds" refers to the delay period set to prevent a Event from being called. Example: If the debounce time is set to 2 seconds, the Event will only execute if there is a 2-second pause. |
Is Copy Enabled checkbox | 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. | |
UI | Component Size |
Note: Currently, we support Component Size |
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 |
| |
Classes |
| |
Validation | Required Type | Here, users can apply validation based on filter conditions.
|
Required Error Message | Enter the error message you want to display for required fields. | |
Minimum Length | Set the minimum number of characters required for the input field. | |
Min Length Error Message | Enter the error message to display if the input does not meet the required minimum length. | |
Maximum Length | Set the maximum number of characters allowed for the input field. | |
Max Length Error Message | Enter the error message to display if the input exceeds the maximum allowed length. | |
Pattern | A regex pattern or regular expression pattern, is a sequence of characters that defines a search pattern. It's used for pattern matching within strings, such as validating input, searching for specific text, or replacing text. | |
Pattern Error Message | A "Pattern Error Message" typically refers to an error generated when input data does not match the expected format defined by a regular expression pattern. This message is usually displayed to inform users that their input is invalid or incorrectly formatted. | |
Visibility | Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Disability | Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
Read Only | Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Component | Component Label | It simply shows the name over the field. |
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 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
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.
0 Comments