Overview
The Form component serves as a container for capturing user inputis a normal form used to input, create, edit, and view records from objects or external services. To utilize its functionality, you must associate the Form must be associated with a model. Once linkeda model is assigned, the fields from the selected object will appear on the left side of the interface. You can then , allowing you to drag and drop these fields them into the Form.. Additionally, you can add multiple actions to the Form. One of these actions can be designated as the primary action, allowing you to define the main actionadded to the Form for enhanced functionality.
...
Attributes
...
Attributes are the options available for each component, allowing you to customize its appearance and control their behavior. It includes various sections explained below.
Basic:
...
Attribute Name | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Component Size |
| |||||||||||
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. | |||||||||||
Grid Size | It defines the width of the component in terms of grid columns, allowing users to control how much horizontal space the section occupies on the page. | |||||||||||
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.
| |||||||||||
No Action Bar | If the “No "No Action Bar” Bar" checkbox is selected, the action bar, which contains all associated actions for the form, 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.
| |||||||||||
Primary Actions | You can select a primary action from the available optionsactions. Pressing the Enter key will execute this primary selected action. | |||||||||||
Overflow After | This feature allows you to control If the number of actions displayed. Setting exceeds the provided limit to 1 will show only one action, with , the additional actions appearing will be displayed in a drop-down menudropdown. |
UI Attributes:
...
Attribute Name
...
Description
...
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.
...
Layout Type
...
It is used to set the layout type in two ways as:
Grid: The Grid Layout Type provides a grid-based layout system consisting of rows and columns. This layout type simplifies the process of designing and structuring a layout, allowing for precise placement and alignment of components within the grid.
Flow: The Flow Layout Type is used for positioning and formatting components within a layout. This layout type allows components to be positioned in relation to each other.
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
...
|
UI Attributes:
...
| Include Page | ||||
|---|---|---|---|---|
|
UI State:
...
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
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Disability
Attribute Name
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
Component
...
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, unlike in a horizontal layoutand displayed in single column grid. |
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.
| ||
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.
| ||
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
...
:
...
Attribute Name | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Component Size |
| |||||||||||
Display As | Display As allows you to select data type options to define how the field will be display.
| |||||||||||
Label | A Label is the name shown to users and can come from various sources.
| |||||||||||
Place holder | This is a hint or example text displayed in an input field before the user enters their own data. |
UI :
...
Attribute Name | Description | ||
|---|---|---|---|
Layout | Field Layout allows you to arrange fields on the form.
|
|
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
Debounce time in seconds
"Debounce time in seconds" refers to the delay period set to prevent a Event from being called.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
For 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 |
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
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 .
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 here.
Classes
It is used to apply SLDS classes to section, if needed.
Validation
Validation:
...
Attribute Name | Description |
|---|---|
Required Type | Here, users can apply validation based on filter conditions.
|
Required Error |
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. |
UI State:
...
Attribute Name | Description | ||
|---|---|---|---|
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:
|
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Component
Component Label
Base UI:
...
Attribute Name | Description |
|---|---|
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 | It is used to apply SLDS classes to component, if needed. |
Hide Space | After marking this checkbox as true, it will crop the extra corners of the fields. |
| Include Page | ||||
|---|---|---|---|---|
|
Events
...
| Include Page |
|---|
...
|