Icon Field

Overview

An Icon Field is a UI element that displays icons, which are small graphical symbols used to represent actions, functions, or categories within an application. Icons in this field provide a visual way to convey meaning or trigger specific functions.

Attributes of of Text field

 

Basic:

image-20240826-133536.png
Basic

 

Attribute Name

Description

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.

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.

Icon Categories allowed

Here, users can select an icon from different categories: Standard, Custom, Utility, Doctype, or Action.

Image Reference: Icon Categories

Icon Sizes allowed

Here, users can select the icon size from the following options: XX Small, X Small, Small, Medium, or Large.

Icon Categories image:

image-20240826-134653.png
Icon Categories

Icon Sizes Image:

Config:

 

Attribute Name

Description

Attribute Name

Description

Debounce time in seconds

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

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

Value Destination Variables

Here you can choose the variable option from this list.

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:

Config:

Attribute Name

Description

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.

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:

Attribute Name

Description

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.

Validation:

 

Attribute Name

Description

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.

Read Only:

 

Attribute Name

Description

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.

Conditional Disability:

 

Attribute Name

Description

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

Component:

 

Attribute Name

Description

Attribute Name

Description

Component Label

It simply shows the name over the field.

 

Label Source Type:

Attribute

Description

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.

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

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.

on Load Event:

 

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

For more information about Workflow check this out.

onload Events:

  • We have an onload event that runs when the 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.