Overview
The List View component displays records from different objects in a tabular format, organized into rows and columns. It offers features such as pagination, search, sorting, and data export, enabling users to perform various operations on the displayed data.
Although multiple List Views can be created for each object, each List View is linked to a single object.
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 Name | Description |
---|---|
Object |
Note: Metadata and System objects are excluded from the list |
List View |
Note: You can select only one List View at a time. |
List View Selectable ?Checkbox |
Note: After enabling this checkbox, the "Is Object Selectable" checkbox will become available. |
Object Selectable ? Checkbox |
|
Table Actions |
Reference: Create Table Action Configuration |
Overflow After | This feature allows you to control the number of actions displayed. Setting the limit to 1 will show only one action, with additional actions appearing in a drop-down menu. |
Row Actions |
Reference: Create Row Action Configuration |
Column Actions |
Note: When you assign a column action, the record in that column becomes a clickable link. Reference: Column Actions |
Layout For New | You can choose an existing layout from the list. |
Same for Edit? |
|
Layout For Edit Checkbox | You can select any layout from the drop-down for editing purposes. |
Offset | You can set an offset for the query on the object. For example, if there are 200 records and you set the offset to 100, the List View will display records starting from the 101st record. |
Limit | Set the number of records to query at once. For example, if there are 200 records for an object and you set the limit to 100, the List View will retrieve and display the first 100 records. |
Order By |
Reference: Order By |
Filter Section Header | Users have the option to customize the header name that appears on the filter section on List View. |
Config and UI Attributes:
Attribute Group | Attribute Name | Description |
---|---|---|
Config | Icon |
Note: The default icon size set as Small |
Show Index Checkbox | Enabling this checkbox will display the index of records in the List View. | |
Export supported Checkbox | If you check that checkbox then the download icon will appear on the right side of the search box Note: Upon clicking the download icon on the List View, all the records can be exported in a CSV file | |
UI | Component Size |
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 |
| |
Classes |
|
Visibility and Components
Attribute Name | Description |
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
Reference: Conditional Visibility |
Component Label | It simply shows the name of the component. |
Table and Row Actions
Attributes | Description |
---|---|
Label | A Label is the name shown to users and can come from various sources. Reference: Source Type |
Name | Enter a unique the name for your action. |
Icon | This option lets you choose from various icons to add to the action button. |
Variant | This feature allows users to change the appearance of the action button.
|
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
Reference: Conditional Visibility |
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
Reference: Conditional Disability |
Is Bulk Action Checkbox | If the bulk action checkbox is marked as true, it enables users to perform bulk actions on the selected items. |
Minimum Record Count | The "Minimum Record Count" setting allows users to specify the minimum number of records required to perform a bulk action. This ensures that bulk actions are only triggered when a certain threshold of selected records is met |
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. |
Column actions
Column Action Attributes | Description |
---|---|
Label | A Label is the name shown to users and can come from various value sources. Reference: Label Value Source |
Name | Enter the unique for Column Action. |
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
Column | Here, users can select the fields displayed in the List View table. |
Label Value Source:
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. |
Order By:
Order By Attributes | Description |
---|---|
Field Name | Here user can select the object field. |
Sort As | Here, you can sort the fields in either Ascending Order or Descending Order. |
Conditional Visibility Type:
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:
|
Conditional Disability Type:
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. |
Value | Here user can select the value from different Source Type. Reference: Merge Text |
Conditional Read Only:
Attribute Name | Description |
Read Only Type | It specifies whether a component can be edited by users. It offers the following options:
|
Add Condition & Group Condition
Condition | Description |
---|---|
Add Condition |
|
Add Group Condition |
|
Filter Operator:
Note: Before using the filter criteria, it's important to understand which filter operators are supported for each field type
Filters Attributes:
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, only onload event actions are available for this components.
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.
Reference: Workflow
Onload Event:
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
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.
Add Comment