Versions Compared

Key

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

Overview

A Text Area is an input element designed for users to enter larger amounts of text, typically spanning multiple lines. Unlike a standard text field, which is usually limited to a single line, a Text Area provides more space, making it ideal for longer inputs such as comments, descriptions, or messages.

They may also include features like placeholders, character limits, and formatting options. Text Areas are commonly used in forms, feedback sections, and any interface where extended text input is required.

Attributes of of Text field

Basic:

...

Attribute Name

...

Date-Time field is a data type used to capture and store specific points in time, including both date and time components. This field allows for precise tracking of moments, such as events, deadlines, or timestamps.

Attributes of Date Time Field

Basic:

...

Attribute Name

Description

Debounce time in seconds

"Debounce time in seconds" refers to the delay period set to prevent a Event from being called.

Info

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.

Value Destination

Attribute Name

Description

Component Size

  • This allows users to modify the size of a specific component according to the grid size of layout.

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.

Field Type

Here you can choose different field types.

Info

Reference: Field Type.

Layout

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

Hide Space Checkbox

After marking this checkbox as true, it will crop the extra corners of the fields.

Config:

image-20240826-071147.pngImage Removed

...

Dest Types

This attribute specifies whether the user wants to store a value in a variable or a model.
Variable: If you choose the variable option, you can select the variable where you want to save the field's value. You can bind this variable's value to the component by creating the appropriate variable.

Model: Here,

you

the user can select

"Model" as the value destination.
Info

Note: Value Destination Model field appears when you select "Model" as the Value Destination Type.

Value Destination Variables

the model and specify the field where the value will be stored.

Dest Var

Here you can choose the variable option from

this

variable list.

Info

Note: This appears when you select "Variable"

as

in the

Value Destination

Dest Type.

Value Destination

Dest Model

From the value destination model,

Here you can

select the specific model where you want to save the field's value.
  • By using a model, you can bind a value to the component, with the value coming from the object used during model creation.

  • UI:

    ...

    choose the model from list. or it provide option for new model creation.

    Note: This appears when you select "Model" in the Dest Type.

    Info

    Reference: How to Create a Record Type Model

    Config:

    image-20240927-131653.pngImage Added

    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.

    InfoNote: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 .

    Datetime Format

    Here, you can set different types of date formats.

    Hours format

    Here, users can set the hour format to either 12-hour or 24-hour.

    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

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

    Classes

    • It is used to apply SLDS classes to section, if needed.

    Conditional Visibility:

    ...

    Hide Space

    After marking this checkbox as true, it will crop the extra corners of the fields.

    UI State:

    ...

    Visibility Type:

    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

    Validation:

    image-20240826-071836.pngImage Removed

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

    Read Only:

    image-20240823-085059.pngImage Removed

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

    Info

    Reference: Read Only

    ...

    Disability Type:

    ...

    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 Disability Type here

    Info

    Reference: Conditional Disability

    Component:

    ...

    Validation:

    image-20240826-105144.pngImage Added

    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 Message

    Enter the error message you want to display for required fields.

    Minimum Date

    Here, users can set the minimum date that can be selected.

    Maximum Date

    Here, users can set the Maximum date that can be selected.

    UI:

    ...

    Attribute Name

    Description

    Component Label

    It simply shows the name over the field.

    Layout

    Field Layout allows you to arrange fields on the form.

    Info

    For more details check this Reference: Field Layout

    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.

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

    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.

    ...

    Icon Events

    Description

    onload

    This event action is triggered when the Field component is loaded.

    change

    This event action is triggered when the field is changed..

    blur

    This event action is triggered when the field is unfocused.

    Below here is the onload event workflow action.

    ...