Form
Overview
The Form component is a normal form used to input, create, edit, and view records from objects or external services. To utilize its functionality, the Form must be associated with a model. Once a model is assigned, the fields will appear on the left side of the interface, allowing you to drag and drop them into the Form. Additionally, multiple actions can be added 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 |
For example, |
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 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 Action Bar" checkbox is selected, the action bar, which contains all associated actions for the form, will be hidden. |
Action | You can include multiple actions, each displayed as a button. Clicking a button initiates a specific action or workflow. |
Primary Actions | You can select a primary action from the available actions. Pressing the Enter key will execute this selected action. |
Overflow After | If the number of actions exceeds the provided limit, the additional actions will be displayed in a dropdown. |
UI Attributes:
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 Type | It specifies whether a component can be edited by users. It offers the following options:
|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
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. |
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 | 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. |
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. |
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. |
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. |
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:
|
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. |