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

Overview

The Form component serves as a container for capturing user input. To utilize its functionality, you must associate the Form with a model. 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..

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

image-20240816-064217.png

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

image-20240820-065750.png

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.
For more details check this

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: Action

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

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

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

  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.

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

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

Reference: Conditional Visibility.

Read Only

image-20240820-110826.png

Attribute Name

Description

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.

Reference: Read Only

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.

Reference: Condition Disability.

Component

image-20240820-111135.png

Attribute Name

Description

Component Label

It simply shows the name of the Rating component.

Field Layout Configuration

image-20240813-122055.png

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

image-20240813-121054.png

Attributes

Description

Label

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

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:

image-20240813-133213.png

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:

image-20240813-130101.png

Basic Attributes:

image-20240820-070302.png

Attribute Name

Description

Label

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

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.

Layout

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

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:

image-20240820-070959.png

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.

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

  • 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

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

  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.

Reference: Conditional Visibility.

Disability

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.

Reference: Conditional Disability

Read Only

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.

Reference: Conditional Read Only

Component

Component Label

It simply shows the name over the field.

Conditional Visibility Type:

image-20240814-092607.png

Attributes Name

Description

Destination Type

Users can select the destination type where the visibility criteria must be applied.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Destination Type

Destination Type

Description

Model

From this source, users can select a Model field to be displayed as the destination type.

Variable

Here, users can select the destination type from variables such as Record ID, Is Disabled, Is Read only, or Is Visible.

User

Here, you can choose the label from user fields such as First Name, Last Name, Email, Name, Phone, or Session ID.

Record

It enables to choose record fields as destination type.

Device

It enables user to decide whether the action will be visible on the specific device type or not. Devices supported:

  1. Mobile

  2. Desktop

  3. Tablet

Conditional Disability Type:

image-20240814-093021.png

Attributes Name

Description

Destination Type

Users can select the destination type from various sources.

Reference: Destination Type

Operator

Here, users can select different operators to add filters.

Reference: Filter Operator.

Source Type

Here, you can select the source type from various sources.
Reference: Available Sources.

Value

Here user can select the value from different Source Type.

Reference: Merge Text

Conditional Read Only:

image-20240823-064414.png

Attribute Name

Description

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.

Add Condition & Group Condition

image (21)-20240822-182312.png

Condition

Description

Add Condition

  • The Add Condition feature allows users to define multiple criteria that must be met for a validation rule to trigger.

  • This feature is used to create complex logic by combining different conditions that Salesforce evaluates before allowing a record to be saved.

Add Group Condition

  • The Add Group Condition feature allows users to group multiple conditions together, creating complex logic that involves different sets of criteria.

  • This feature is particularly useful when combining conditions that should be evaluated as a unit (logical OR within a group) or when nesting conditions for more advanced logic.

Filter Operator:

Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type

Filters Attributes:

image-20240822-134925.png

Filter Operators

Operator

Supported Field Types

Description

Equal

Number, Currency, Date, Text, Boolean, Picklist

The equal operator is used to compare two values or expressions. It is used to compare numbers, strings, Boolean values, variables, objects, etc. The result is TRUE if the expressions are equal otherwise it’s FALSE

Contains

Text, Picklist

The contains operator returns TRUE if the value on the left contains the value on the right, and otherwise FALSE

Starts With

Text, Picklist

It returns TRUE if a string or number starts with the specified character otherwise it returns FALSE.

Ends With

Text, Picklist

It returns TRUE if a string or number ends with the specified character otherwise it returns FALSE

In

Text, Picklist

IN operator allows you to easily test if the expression matches any value in the list of values. Determines whether the value of an expression is equal to any of several values in a specified list.

Events:

  • Events are essentially the automation of invoking the component's actions.

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

image-20240822-091137.png

In the image below, you can select the created workflows.

image-20240822-084758.png

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

image-20240822-091307.png

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.

image-20240822-093156.png

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