Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

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.

Layout Type

It is used to set the layout type in two ways as:

  1. Grid: The Grid Layout Type provides a grid-based layout system consisting of rows and columns. This layout simplifies the process of designing and structuring a layout, allowing for precise placement and alignment of components within the gridtype divides a component into a specified number of columns. The grid size determines the number of available columns.

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

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.

Info

Reference: Models

Field Layout

Field Layout allows you to arrange fields on the form.
For more details check this

Info

Reference: Field Layout

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.

Info

Reference: Action

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 in a drop-down menuwill be displayed in a dropdown.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

For example, if you have 3 actions, all will be displayed in the section header. If you added the 4th action, it will appear in the drop-down list, along with any subsequent actions.

UI Attributes:

...

Include Page
UI Attributes
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:

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

Info

Reference: Conditional Visibility.

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. 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 Read Only here.

Info

Reference: Read Only

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.

Info

Reference: Condition Disability.

...

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.

Info

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

  1. Neutral

  2. Brand

  3. Outline Brand

  4. Success

  5. Destructive

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.

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.

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.

Info

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:

...

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.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

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.

Panel
panelIconId1f5e8
panelIcon:speech_left:
panelIconText🗨️
bgColor#F4F5F7

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

A Label is the name shown to users and can come from various sources.

Info

Reference: Label Source Type

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.

Info

For more details check this

Info

Reference: Field

Layout

UI :

image-20240925-124607.pngImage Removed

Attribute Name

Description

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.

Validation:

...

Attribute Name

Description

Required Type

Here, users can apply validation based on filter conditions.

  1. Never: This field is never required.

  2. Always: This field is always required..

  3. Conditional: The required field is determined based on specific criteria of And, OR condition

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:

  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.

Info

Reference: Conditional Visibility.

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.

Info

Reference: Conditional Disability

Read Only Type

It specifies whether a component can be edited by users. It offers the following options:

  1. Never: The component will always be editable at any time.

  2. Always: The component will never be editable.

  3. Conditional: The component's editability is determined based on specific criteria, which can make it either editable or read only as needed.

Info

Reference: Conditional Read Only

...

Include Page
Visibility and Disability
Visibility and Disability

Events

...

Include Page

...

Events (Common)
Events (Common)