...
Fields can hold different types of data, such as numbers, phone numbers, email addresses, and text, depending on the data type configuration.
Fields can be bound to models and variables, enabling dynamic data handling and updates within your application.
The Field component is generic and can be configured to accept and display data in multiple formats and types.
If you need to present or capture data without linking it to a specific object, the Field component can be used independently.
...
...
Attributes:
Attributes are the options available for each component, allowing you to customize its appearance and functionality. They help you tailor the look and behavior of your components to fit your needs.
Basic
...
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.
| 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.
Attribute Name | Description | ||
|---|---|---|---|
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. | ||
Field Type | Here you can choose different field types.
| ||
Layout | Field Layout allows you to arrange fields on the form. | ||
Hide Space Checkbox | After marking this checkbox as true, it will crop the extra corners of the fields. |
Config and UI Attributes:
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. | |||||||||||
Type | Here you can choose different field types.
| |||||||||||
Dest Type | This attribute specifies whether the user wants to store a value in a variable or a model. Model: Here, you can select "Model" as the value destination. |
Note: Value Destination Model field appears when you select "Model" as the Value Destination Type. |
Dest Var | Here you can choose the variable option from this list. |
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.
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.
| Info |
|---|
Note: Currently, we support Component Size |
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.
Validation
Required Type
Here, users can apply validation based on filter conditions.
Never: This field is never required.
Always: This field is always required..
Layout | Field Layout allows you to arrange fields on the form. |
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 |
|
Hide Space | After marking this checkbox as true, it will crop the extra corners of the fields. |
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. |
Min Length | Set the minimum number of characters required for the input field. |
Min Length Error |
Enter the error message to display if the input does not meet the required minimum length. |
Max Length | Set the maximum number of characters allowed for the input field. |
Max Length Error |
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 |
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:
...
Visibility Type:
Attribute Name | Description |
|---|---|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Disability
|
Read Only Type:
Attribute Name | Description |
|---|---|
Read Only Type | It |
specifies whether a component |
can be edited by users. It offers the following |
options:
|
|
|
|
|
|
|
|
Read Only Type
Disability Type:
Attribute Name | Description |
|---|---|
Disability Type | It determines whether a component is disable on the layout. It offers the following |
visibility types:
|
|
|
|
|
|
|
Component
Component Label
It simply shows the name over the field.
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.
Field Types:
Field Types
Description
text
Text refers to any written or printed words or characters displayed within a field or interface.
textarea
A textarea is a multi-line input field that allows users to enter larger amounts of text.
rich textarea
A rich text area is an input field that allows users to enter and format text with styling options like bold, italics, lists, and more.
checkbox
An interactive element that lets users select or deselect an option by checking a box.
integer
An integer field is a data input field that accepts whole numbers without decimal points.
double
A double field is a data input field that accepts numerical values with decimal points.
currency
A currency field is a data input field that accepts numerical values formatted as monetary amounts.
date
A date field is an input field that allows users to select or enter a date, typically displayed in a calendar format.
datetime
A datetime field is an input field that allows users to select or enter both a date and a time.
time
|
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 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. |
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. |
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. |
Field Types:
...
Field Types | Description | ||
|---|---|---|---|
Text | Text refers to any written or printed words or characters displayed within a field or interface.
| ||
Text Area | A text Area is a multi-line input field that allows users to enter larger amounts of text.
| ||
Rich Text Area | A Rich Text Area is an input field that allows users to select or enter a specific time of day. | ||
picklist | A picklist is a dropdown menu that allows users to select a single value from a predefined list of options. | ||
multipicklist | A multipicklist is a dropdown menu that allows users to select multiple values from a predefined list of options. | ||
tag | A tag is a label or keyword that is used to categorize or identify items. | ||
array | An array is a data structure that holds a collection of items. | ||
object | A data structure that represents a collection of related properties and methods, used to model entities. | ||
criteria | Criteria are conditions or rules used to filter or evaluate data based on specific requirements or attributes. | ||
An email field is an input field designed for entering and validating email addresses. | |||
password | A password field is an input field that obscures entered text to ensure confidentiality and is used for entering passwords. | ||
phone | A phone field is an input field designed for entering and formatting mobile numbers. | ||
URL | A URL field is an input field for entering and validating web addresses or links. | ||
Jsons | A JSON field is used for entering and storing data in JavaScript Object Notation (JSON) format, which is a lightweight data-interchange format. | ||
Slider | A slider is an interactive UI element that allows users to adjust a value within a specified range by moving a handle along a track. | ||
Action | An action refers to a specific operation or task that can be triggered or performed, such as a button click or a menu selection. | ||
icon | An icon is a small graphic or symbol used to represent an application, function, or action in a user interface. | ||
model | A model is a representation or structure used to define and manage data, often encompassing the rules and relationships of data in a system or application. | ||
fields | Fields are individual data elements or attributes within a data model or form, used to capture and store specific pieces of information. | ||
radio | A radio button is a selection input that allows users to choose one option from a set of predefined choices. | ||
image | An image field is used to display or upload visual content, such as pictures or graphics, within a user interface. | ||
images | An image field is used to display or upload multiple visual content, such as pictures or graphics, within a user interface. | ||
lookup | A lookup field is an input field that allows users to search for and select a related record from another table or dataset. | ||
color | A color field is an input field that allows users to select or specify a color, often using a color picker or color code. | ||
record | A record is a collection of related data fields or attributes that represent a single item or entry in a database or data system. | ||
Formulae | A formula field allows users to calculate and display values based on a formula that combines other fields, constants, or functions. | ||
Merge Text | Merge text refers to combining or inserting dynamic values from multiple sources into a single text field or document, often used for generating personalized content. | ||
Field Selector | A field selector is an interface element that allows users to choose and specify which fields to display or use within a form, report, or data view. | ||
Visual Picker | A visual picker is a UI component that lets users select options or values from a graphical representation, such as images or icons, rather than text-based lists. | ||
Percentage | A percentage field is an input field designed to enter and display values as a percentage. | ||
Address | An address field is an input field used for entering and formatting address information, including details like street, city, state, and zip code. | ||
Number | A number field is an input field designed to enter and validate numerical values, which may include options for specifying the range or format. | ||
Boolean | A boolean field is an input field that stores a value representing one of two states, typically "true" or "false." | ||
html | An HTML field is used for entering and displaying content in HyperText Markup Language, allowing for structured and formatted text with various elements. | ||
css | A CSS field is used for entering and applying Cascading Style Sheets, allowing users to define the appearance and layout of HTML elements with styles. | ||
javascript | A JavaScript field is used for entering and executing JavaScript code, allowing for dynamic behavior and interactions on web pages. | ||
Duration | A duration field is an input field that allows users to specify a length of time. | ||
Encrpyted | An encrypted field is a data input field that stores information in an encrypted format | ||
Filter | A filter is a tool or feature that allows users to narrow down or sort data based on specific criteria or conditions. | ||
any | The term "any" is used to indicate that a condition or action applies to all possible values or options within a given context. | ||
Model Selector | A model selector is a UI component that allows users to choose or specify a data model or schema to use within an application or system. | ||
Categories Selector | A model selector is a UI component that allows users to choose or specify a data model or schema to use within an application or system. | ||
Device | A device refers to a physical or virtual piece of hardware used to perform tasks, access information, or interact with software, such as a computer, smartphone, or tablet. | ||
Progress Bar | A progress bar is a graphical element that visually displays the completion status of a task or process, often as a horizontal bar filled to indicate the percentage of completion. | ||
Rating | A rating is a UI element that allows users to evaluate or provide feedback on a product, service, or content, typically represented by stars, numbers, or other symbols. |
Events
Events available for any component is of onload type.
Onload Events:
...
onload event occurs when the component has been loaded.
...
Here, only onload event actions are available for components.
enter and format text with styling options like bold, italics, lists, and more.
| |||
Checkbox | An interactive element that lets users select or deselect an option by checking a box.
| ||
Integer | An Integer field is a data input field that accepts whole numbers without decimal points.
| ||
Double | A Double field is a data input field that accepts numerical values with decimal points.
| ||
Currency | A Currency field is a data input field that accepts numerical values formatted as monetary amounts.
| ||
Date | A Date field is an input field that allows users to select or enter a date, typically displayed in a calendar format.
| ||
Datetime | A Datetime field is an input field that allows users to select or enter both a date and a time.
| ||
Time | A Time field is an input field that allows users to select or enter a specific time of day.
| ||
Picklist | A picklist is a dropdown menu that allows users to select a single value from a predefined list of options.
| ||
Multi Picklist | A Multi Picklist is a dropdown menu that allows users to select multiple values from a predefined list of options.
| ||
Tag | A Tag is a label or keyword that is used to categorize or identify items.
| ||
Array | An array is a data structure that holds a collection of items.
| ||
Object | Object is data structure that represents a collection of related properties and methods, used to model entities.
| ||
Criteria | Criteria are conditions or rules used to filter or evaluate data based on specific requirements or attributes.
| ||
An Email field is an input field designed for entering and validating email addresses.
| |||
Password | A Password field is an input field that obscures entered text to ensure confidentiality and is used for entering passwords.
| ||
Phone | A Phone field is an input field designed for entering and formatting mobile numbers.
| ||
URL | A URL field is an input field for entering and validating web addresses or links.
| ||
Jsons | A JSON field is used for entering and storing data in JavaScript Object Notation (JSON) format, which is a lightweight data-interchange format.
| ||
Slider | A Slider is an interactive UI element that allows users to adjust a value within a specified range by moving a handle along a track.
| ||
Action | An Action refers to a specific operation or task that can be triggered or performed, such as a button click or a menu selection.
| ||
Icon | An icon is a small graphic or symbol used to represent an application, function, or action in a user interface.
| ||
Model | A model is a representation or structure used to define and manage data, often encompassing the rules and relationships of data in a system or application.
| ||
Fields | Fields are individual data elements or attributes within a data model or form, used to capture and store specific pieces of information.
| ||
Radio | A Radio button is a selection input that allows users to choose one option from a set of predefined choices.
| ||
Image | An image field is used to display or upload visual content, such as pictures or graphics, within a user interface.
| ||
Images | An Image field is used to display or upload multiple visual content, such as pictures or graphics, within a user interface.
| ||
Lookup | A lookup field is an input field that allows users to search for and select a related record from another table or dataset.
| ||
Color | A Color field is an input field that allows users to select or specify a color, often using a color picker or color code.
| ||
Record | A Record is a collection of related data fields or attributes that represent a single item or entry in a database or data system.
| ||
Formulae | A Formula field allows users to calculate and display values based on a formula that combines other fields, constants, or functions.
| ||
Merge Text | Merge Text refers to combining or inserting dynamic values from multiple sources into a single text field or document, often used for generating personalized content.
| ||
Field Selector | A Field Selector is an interface element that allows users to choose and specify which fields to display or use within a form, report, or data view.
| ||
Visual Picker | A Visual Picker is a UI component that lets users select options or values from a graphical representation, such as images or icons, rather than text-based lists.
| ||
Percentage | A Percentage field is an input field designed to enter and display values as a percentage.
| ||
Address | An Address field is an input field used for entering and formatting address information, including details like street, city, state, and zip code.
| ||
Number | A Number field is an input field designed to enter and validate numerical values, which may include options for specifying the range or format.
| ||
Boolean | A Boolean field is an input field that stores a value representing one of two states, typically "true" or "false."
| ||
HTML | An HTML field is used for entering and displaying content in Hyper Text Markup Language, allowing for structured and formatted text with various elements.
| ||
CSS | A CSS field is used for entering and applying Cascading Style Sheets, allowing users to define the appearance and layout of HTML elements with styles.
| ||
Java Script | A JavaScript field is used for entering and executing JavaScript code, allowing for dynamic behavior and interactions on web pages.
| ||
Duration | A Duration field is an input field that allows users to specify a length of time.
| ||
Encrypted | An Encrypted field is a data input field that stores information in an encrypted format.
| ||
Filter | A Filter is a tool or feature that allows users to narrow down or sort data based on specific criteria or conditions.
| ||
Any | The term "any" is used to indicate that a condition or action applies to all possible values or options within a given context.
| ||
Model Selector | A Model Selector is a UI component that allows users to choose or specify a data model or schema to use within an application or system.
| ||
Categories Selector | Categories Selector typically refers to a feature or tool that allows users to choose from a list of predefined categories. This helps in organizing and filtering content or data based on the selected categories.
| ||
Device | A Device refers to a physical or virtual piece of hardware used to perform tasks, access information, or interact with software, such as a computer, smartphone, or tablet.
| ||
Progress Bar | A Progress Bar is a graphical element that visually displays the completion status of a task or process, often as a horizontal bar filled to indicate the percentage of completion.
| ||
Rating | A Rating is a UI element that allows users to evaluate or provide feedback on a product, service, or content, typically represented by stars, numbers, or other symbols.
|
| Include Page | ||||
|---|---|---|---|---|
|
Events:
Events are essentially the automation of invoking the component's actions.
Here, we have onload event, click, double click actions are available for this components.
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 |
Below here is the onload event workflow action.
Note: Similarly you can create event action for change event and blur.
on Load Event:
...
In the image below, you can select the created workflows.
...
Note: You need to create a workflow for selecting from this list.
For more information about Workflow check this out.
| Info |
|---|
Reference: Workflow |
onload Events:
We have an onload event that runs when the component is loaded
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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
...
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.
