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.

image-20240816-095830.png
List View

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:

image-20240925-133149.png
Basic

Attribute Name

Description

Attribute Name

Description

Component Size

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

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.

Object

  • You are required to choose the object for displaying the List View.

  • Only standard and custom objects will be available for selection here.

Note: Metadata and System objects are excluded from the list

List View

  • You can choose a List View name from the available options.

  • Each object can have multiple List Views.

Note: You can select only one List View at a time.

Table Actions

  • You can create multiple table actions for the List View. By default, two actions are visible in the top right corner.

  • These actions are used to perform operations such as creating, refreshing, and managing selected or unselected records

Row Actions

  • Actions are performed at the record level for individual records.

  • These actions are primarily used to read, update, or delete a single record.

  • Each action is linked to a workflow that executes the specific operation. While default row actions include edit, delete, and view, you have the flexibility to create additional actions according to your needs.

Column Actions

  • You can set the actions at the column level on the List View.

  • You can assign only one action to any column.

  • When you click record in the column action gets executed. Each action has a workflow that actually performs an operation.

Layout For New

You can choose an existing layout from the list.

Same for Edit?

  • If the “Same for Edit” checkbox is enabled, the layout selected for “Layout For New” will also apply to Edit operations.

  • If disabled, you can choose a different layout for editing from the available options.

Layout For Edit Checkbox

You can select any layout from the drop-down for editing purposes.

Order By

  • You can specify the order in which fields are used to query and display records in the List View.

  • Records can be sorted in either ascending or descending order.

Config:

Attribute Name

Description

Attribute Name

Description

Icon

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

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

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:

  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

Base UI:

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.

UI:

Attribute Name

Description

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

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.

  1. Neutral

  2. Brand

  3. Outline Brand

  4. Success

  5. Destructive

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

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 Visibility Type here.

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

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

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:

  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 attribute

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.

Column

Here, users can select the fields displayed in the List View table.

Label Value Source:

Label Source Type Attribute

Description

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

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