RIO Ed - Related List - Single (LWC)
rio_ed:customSingleRelatedListLwc
Table of Contents
| Component Name | RIO Ed - Related List - Single (LWC) |
| API Name | rio_ed:customSingleRelatedListLwc |
| Type | Standalone |
| Recommended Pages | Any record page in both internal or digital experience |
| Supported In | Both Salesforce internal and Digital Experience |
New in v3.22
Please Note: This page refers to a new Lightning Web Component version accessible after v3.22. If you are looking for the original component, please see RIO Ed - Related List - Single (Aura).
The RIO Ed - Related List - Single (LWC) component is a custom related list, as opposed to the standard one in Salesforce (Related List - Single).
Note: The date/time field in custom single related list component respects the timezone configured in Salesforce user's profile.
The following explains the steps to display a related list of Course Connection records when viewing a Contact:
- Under the Contact object, add in the RIO Ed - Related List - Single (Aura) component.
- Set the 'Target Record Id Field' = 'Id' ('Id' here referring to the ID of the record itself).
This is to make only the list show records relevant to the Contact we are viewing. - Set the 'Child Object API Name' = 'hed__Course_Enrollment__c' (the API name for Course Connection).
We want Course Connection to be the records listed. - Set the 'Parent Object Reference Field' = 'hed__Contact__c'.
Course Connection is linked to a Contact through the lookup field 'hed__Contact__c'. - Set the 'Child Object Fields Set API Name' = 'Name;hed__Course_Offering__c;rio_ed__Enrollment_Status__c;hed__Grade__c'
(The API names for each field to display, separated by a semi-colon ; )
| Attribute Name | API Name | Description |
|---|---|---|
| Title | modalTitle | Title of the component. |
| Modal Icon Name | modalIconName | Component modal icon name. Uses Lightning Design System icons. |
| View Mode | viewMode | Display mode: Related List, Datatable or Tile. |
| Target Record Id | targetRecordId |
The current record id.
Only available in Digital Experience, not available in Salesforce internal. |
| Target Record Id Field | targetRecordIdField | The Id field (master-detailed/lookup) API name from the current object to be used in searching related child records based on Parent Object Reference Field. |
| Parent Object Reference Field | parentObjectRefField | API name of the parent object reference field in the child object. |
| Child Object API Name | childObjectApiName | API name of the child object (e.g., reduivy__Individual_Program_Application__c). |
| Child Object Fields API Name | childObjectFields | API names of fields to display as columns, separated by semicolons. |
| Child Record Filter Criteria | childObjectFilterCriteria | Criteria to filter child records (e.g., RecordTypeId = 'xxxxxx'). |
| Sorted By | sortedBy | Field name used for sorting (default: Name). |
| Sorted Direction | sortedDirection | Sorting order: asc or desc. |
| Show New Button | enableNewButton | Show a button to create new records. |
| Show View Button | enableRowViewButton | Show a button to view a record. |
| Show Edit Button | enableRowEditButton | Show a button to edit a record. |
| Edit Field Set API Name | editFieldSetName | Field Set Name for fields displayed on the edit page. |
| Show Delete Button | enableRowDeleteButton | Show a button to delete a record. |
| Show Download Button | enableRowDownloadButton | Show a button to download files (applies to ContentVersion). |
| Download URL | downloadUrl | URL to download the file, with {0} replaced by the record ID. |
| Maximum Height | maxHeight | Maximum height of the component in pixels. |
| Show Row Number | showRowNumber | Display row numbers. |
| Enable Infinite Loading | enableInfiniteLoading | Enable infinite scrolling. |
| Rows to Load | rowsToLoad | Number of rows to load (default: 10). |
| No Record Found Message | noRecordFoundMessage | Message displayed when no records are found. |
| Make Reference Clickable | enableClickableRefField | Make master-detail or lookup fields clickable. |
| Enable Multiple Row Selection | enableRowSelection | Enable checkboxes for multiple row selection. |
| Inline Editing | enableInlineEditing | Enable inline editing of records. |
| Reference Target | refTarget | Target for opening reference fields (_blank, _self, etc.). |
| Show Refresh Button | enableRefreshButton | Show a refresh button to reload the list. |
| Enable Quick Search | enableQuickSearch | Enable a quick search feature. |
| Tile Image Url Field | tileImageUrlField | Field on target object containing image URL. Incompatible with Tile Image File Description. |
| Tile Image File Parent Id Field | tileImageFileParentIdField | The Id field (master-detailed/lookup) API name of the parent object for a ContentDocumentLink image. Incompatible with Tile Image Url Field. |
| Tile Image File Description | tileImageFileDescription | Description to filter a related ContentDocumentLink (e.g. Profile Image). Incompatible with Tile Image Url Field. |
| Tile Show Image as a Circle | tileImageCircle | Crops the tile image to look like a circle. |
| Tile Title Format | tileTitleFormat | Merge-field style string for title (e.g., {Name} - {Status__c}). |
| Tile Subtitle 1 Format | tileSubtitle1Format | Merge-field style string for subtitle 1 (e.g., {Name} - {Status__c}). |
| Tile Subtitle 2 Format | tileSubtitle2Format | Merge-field style string for subtitle 2 (e.g., {Name} - {Status__c}). |
| Tile Child Fields Layout | tileChildObjectFieldsLayout | The display layout of child fields." default="Stacked" datasource="Stacked,Rows |
| Debug Mode | enableDebugMode | Enable debug mode for troubleshooting. |
| Record Id (Reserved for Internal Use) | recordId | Record Id. |