How do I add an enhanced list to a lightning page?
The Enhanced List is available from the component palette in the lightning page editor and is suitable for deployment to any lightning page.
Supported Display Modes
Enhanced Lists support three display modes, which are made available based on your deployment use case. The supported display modes are:
Enhanced List (Can only be used on a home page, app page, or the utility bar)
This mode is displayed in a list view format with the ability to display a list of records for the chosen object in the component options. This mode supports the ability to retrieve a list of records based on specific filters and sort those records. It optionally allows inline editing of the records as well as the ability to quickly add new records.
Related List (Can only be used on an object record page)
This mode is displayed in a related list format and is available only when the component is placed in the context of an object's record page. This provides a simple way to view any Related List on the record with all the other abilities of enhanced lists.
Batch Entry (Can be used on an object record page, home page, app page, or the utility bar)
This mode is displayed in a batch entry interface where users can enter multiple data records all at once, for any object or related lists. This mode is available on all lightning pages and provides a quicker way to add data records.
1. Deployment Use Cases
Enhanced Lists are designed for use with any object in your organization and within all lightning pages. The different use cases for the component include placing the component:
- ...within the context of a given record as a related list or as a batch entry interface to quickly add multiple records or
- ...on a home page as a dedicated enhanced list of records for any object or as a batch entry interface as well or
- ...in the utility bar.
2. Deployment Options
Enhanced Lists are available under the Custom - Managed section of the page designer's component palette. There are multiple options available for this component:
Use a unique identifier to identify this component on the lightning page. The enhanced list can be deployed multiple times on the same page layout. This option provides each instance of the component a unique set of run-time options.
Optionally display a title above the enhanced list.
This option is available when the enhanced list is placed on a home page or utility bar. Select from the list of available objects to render the enhanced list.
This option is available when the enhanced list is placed on any object's record page. Use this option to include a related list for the record in your lightning page.
For example, when using the component on the matter page, choosing expenses would render the enhanced list for the expenses which are related to the underlying matter.
Use this to render the enhanced list in a specific display format.
Fields to Show
Provide a comma-separated list of field API names to display as columns. The fields set here (by the system administrator) will be what the enhanced list always defaults back to once the local browser cache has been cleared or the user changes browsers altogether.
Provide SOQL compliant sort phrase to display a sorted list of records.
For example, CreatedDate DESC (applicable to enhanced list and related list display modes only)
Provide SOQL compliant filter phrase to retrieve a filtered list of records.
For example, Type = 'Government' (applicable to enhanced list and related list display modes only)
Number of Rows to Display
Defaults the number of rows to show in the list.
Enable Quick Add
Allows the ability to quickly add new records from within the list interface.
Allows the ability to delete a record from within the list interface.
Enable Inline Edit
Allows the ability to quickly edit records from within the list interface.
Hide Action Bar
Enable this to hide the action bar displaying the new button in the list interface.
Enable this to hide the input to search within the list interface.
Hide List Builder
Enable this to hide the list builder option from the list interface.
Disable Previous Row Copy
Enable this to disable the feature of copying of data from previous row when user clicks a text input field in current row.
Optionally display the object's icon in the component header of the enhanced list.
Provide SLDS compliant icon for the enhanced list. When left empty, we'll try to detect the tab style of the selected object and display the associated icon. For example, standard:account