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

Overview

The Tree component is a user interface element designed to display hierarchical data in a tree-like structure. It organizes data into interconnected nodes, allowing users to navigate and interact with the information effectively.

For example, In a Salesforce custom application for managing organizational structure, the Tree component could be used to display the hierarchy of departments and employees. This setup helps users easily navigate through and manage organizational data.

image-20240816-113916.png

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:

image-20240925-151228.png

Attribute Name

Description

Component Size

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

  • This feature allows for flexible customization, enabling users to resize components to fit their specific needs within the defined grid structure.

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.

Model

Creating a New Model: You can either select an existing model from the list or create a new model by clicking on the "Create New Model" option.

Reference: Model Creation

Header Field

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

ID Field

  • Each tree node must have a unique identifier for identification purposes. All fields are visible except for image, address, array, and object type fields.

  • Here you can select the field from the list.

Reference: Id Field

Label Field

The label field is designated for displaying the label of the tree node. All fields are visible except for image, address, array, and object type fields.

Reference: Nodes

Parent Field

The lookup field type should be used as a self-lookup to create a hierarchy. In this context, only lookup fields are visible.

Reference: Parent Node

MIn Height

Max Height

Base UI:

image-20240925-151447.png

Attribute Name

Description

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.

Classes

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

UI:

image-20240925-151545.png

Attribute Name

Description

Icon Field

This is used to display icons for individual nodes, utilizing a field of type ”text” for alternate text.

Reference: Icon Field

Default Icon

You can set the default icon for the tree from the different icon options

  • This field allows you to choose an icon from different categories like utility, action, custom, doctype, and standard

  • You can also select the icon size as XX-Small, X-Small, Small.

  • Additionally. A search bar option is available to search for icons by name

Lazy Load?

This checkbox field is used during hierarchy creation. When enabled, it creates only the parent-level hierarchy, with child nodes loading as the user expands each tree node. There is no visible change in the UI.

Hide Refresh

Checkbox used to hide refresh option.

Hide Search?

Checkbox used to hide the search box of a Tree

No Header

Checkbox used to hide the header part of a Tree

UI State:

image-20240925-151820.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.

Id Field

image-20240821-103131.png

image-20240821-103308.png

  • This ID field is designed to present a list of available options only when the associated UI field is added to the model that has been bound to it.

  • This ensures that the list appears in the context of the data or configuration specified by the model, allowing for a more dynamic and relevant display of options based on the user's selections and the binding context.

Nodes

image-20240821-103801.png
  • This nodes field will display a list of available options only when you include the corresponding UI field in the model that has been bound to it.

  • This functionality ensures that the list is dynamically generated and relevant to the specific configuration of the model,

Parent Node

image-20240821-104539.png

  • This parent node field will show a list of available options only when you add the corresponding UI field to the model that has been bound to it.

  • This ensures that the displayed list is contextually relevant and dynamically generated based on the specific configuration of the bound UI field in the model.

Icon Field

image-20240821-104730.png

  • This icon field will display a list of available options only when the corresponding UI field is added to the model that has been bound to it.

  • This ensures that the list of icons is contextually appropriate and dynamically generated, aligning with the specific configuration of the bound UI field within the model.

Label Source Type:

image-20240813-133213.png

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.

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, we have onload event, search, select actions are available for this components.

image-20240824-094620.png

Tree Events

Description

onload

This event action is triggered when the component is loaded.

search

This event action is triggered when you search in the search bar..

select

This event action is triggered when clicked on search records..

Below here is the onload event workflow action.

Note: Similarly you can create event action for search and select.

on Load Event:

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

  • 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