List View
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 control their behavior. It includes various sections explained below.
Basic:
Attribute Name | Description |
---|---|
Component Size |
For example, |
Object |
Note: Metadata and System objects are excluded from the list |
List View |
Note: You can select only one List View at a time. |
Table Actions |
|
Row Actions |
|
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. |
Order By |
|
Config:
Attribute Name | Description |
---|---|
Icon |
|
Show Index | Enabling this checkbox will display the index of records in the List View. |
Export supported | If you check that checkbox then the download icon will appear on the right side of the search box |
UI State:
Attribute Name | Description |
Visibility Type | It determines whether a component is visible on the layout. It offers the following visibility types:
|
Base UI:
Attribute Name | Description |
---|---|
Component Size |
|
Margin Location |
|
Margin Size |
|
Style |
|
Classes |
|
UI:
Attribute Name | Description |
---|---|
Listview Selectable? | Selecting this checkbox enables the list view selection dropdown option on the list view name. |
Offset | You can set an offset for the query on the object. |
Limit | Set the number of records to query at once. |
Filter Section Header | Users have the option to customize the header name that appears on the filter section on List View. |
Table and Row Actions
Attributes | Description |
---|---|
Label | A Label is the name shown to users and can come from various sources. |
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:
|
Disability Type | It determines whether a component is disable on the layout. It offers the following visibility types:
|
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 |
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. |
Column actions
Column Action Attributes | Description |
---|---|
Label | A Label is the name shown to users and can come from various value sources. |
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 | 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. |
Order By
In Salesforce, there’s no guarantee of the order of results unless you use an Order By
clause in a query. Thus, we need to specify Order By
to have specific records under consideration.
Specifies whether the results are ordered in ascending (ASC) or descending (DESC) order. Default order is ascending.
Order By Attribute | Description |
---|---|
Field Name | Allows to specify field name which determines the sorting order of the query results. |
Sort As | Allows to specify whether the results are ordered in Ascending or Descending order. |
Events