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

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

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

image-20240820-073908.png

Attribute Name

Description

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 Name

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

Is List View Selectable Checkbox

  • This feature allows users to change the List View dynamically within the layout.

  • When enabled, a drop-down icon appears next to the object selector in the layout.

Note: After enabling this checkbox, the "Is Object Selectable" checkbox will become available.

Is Object Selectable

Checkbox

  • This feature allows the end user to change the object at runtime.

  • When enabled, a drop-down icon appears next to the List View selector in layout.

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

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

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

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.

Layout for Edit Is Same As New

Checkbox

  • If the “Layout for Edit Is Same As New” 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.

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

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

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:

image-20240820-074123.png

Attribute Group

Attribute Name

Description

Config

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

Note: The default icon size set as Small

Show Index Checkbox

Enabling this checkbox will display the index of records in the List View.

Is 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

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

Note: Currently, we support Component Size 1 for Section. All other sizes will throw an error alert displaying Max allowed value is 1 .

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.

Visibility and Components

image-20240820-100302.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 attribute

Component Label

It simply shows the name of the component.

Table Actions

image-20240813-121054.pngimage-20240821-063509.pngimage-20240821-063035.png

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.

  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 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.
    You can explore more about Visibility Type attribute.

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:

image-20240813-133213.png

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.

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:

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.

Order By:

image-20240814-145009.png

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.

Events:

  • Events are essentially the automation of invoking the component's actions.

  • Here, only onload event actions are available for this components.

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

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