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:

...

An Images Field is a UI component designed to handle multiple images within an application. It allows users to upload, display, and manage a collection of images, offering a way to incorporate and organize visual content in bulk.

Attributes of of Images Field

Basic:

...

Attribute Name

Description

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.

Allow Sources

Here, users can select the image source as Attachment, Record, or URL.

Allowed Format

Here, users can select the image format as PNG, JPG, JPEG, GIF, or SVG.

Allowed Shown As

Here, users can select the image display style from Carousel, Grid Thumbnail, Grid Small, Grid Medium, Grid Large, or Table.

Default Shown As

Here, users can select the default display style from Carousel, Grid Thumbnail, Grid Small, Grid Medium, Grid Large, or Table.

Config:

image-20240826-071147.pngImage Removedimage-20240826-143843.pngImage Added

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 fieldAspect Ratio Width

Here, users can set the aspect ratio width of the image.

Aspect Ratio Height

Here, users can set the aspect ratio height of the image.

Show Tool Tip Checkbox

If the "Show Tooltip" checkbox is marked as true, the tooltip will be displayed.

Show alt Text Checkbox

If the "Show Alt Text" checkbox is marked as true, the alt text will be displayed.

Show Description Checkbox

If the "Show Description" checkbox is marked as true, the description will be displayed.

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

Here you can choose the variable option from this list.

Info

Note: This appears when you select "Variable" as the Value Destination Type.

Value Destination Model

  • From the value destination model, 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.

...

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.

Info

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.

Classes

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

Attachment Path

Here, users can select attachments from different sources.

Info

Reference: Attachment Path

Display Width

Here, users can set the size of the image width.

Display Height

Here, users can set the size of the image height.

Conditional Visibility:

...

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 Removedimage-20240826-144958.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 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 formattedMax Attachment Content Length (KB)

Here, users can set the maximum attachment content length in KB.

Max Record Content Length (KB)

Here, users can set the maximum record content length in KB.

Min Width

Here, users can set the minimum width.

Max Width

Here, users can set the maximum width.

Min Height

Here, users can set the minimum height.

Max Height

Here, users can set the maximum height.

Read Only:

image-20240823-085059.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 Type here.

Info

Reference: Read Only

...

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.

...