SharinPix Related Record Albums (LWC)
The SharinPix Related Record Albums (LWC) can be used to display a list of related records along with their corresponding SharinPix Albums on the parent record.
This article will cover:
Information:
This feature is only available on Lightning. It can be used:
- On Page Builder
- On Desktop
- On Mobile
- In your own Lightning Component development
- On Community Builder
Note:
- An additional configuration is required in the Community Builder to use the SharinPix Related Record Albums component in Salesforce Community (Experience Cloud). Check the Related Object parameter's description in the Lightning Component Parameters section for more details.
- This component is the Lightning Web Component version of the SharinPix Album. For the Aura version, refer to this article.
Getting Started
To use the SharinPix Related Record Albums (LWC) component, you simply need to drag and drop the component from the Lightning App Builder onto your page layout.
Lightning Component Parameters
| Parameter | Description | Notes / Examples |
|---|---|---|
| Related Object | Specifies the related or child object type to display. |
Salesforce Community usage: Enter manually in the format: RelatedObjectApiName#LookupFieldApiName.Examples: - Display related Contacts on an Account page: Contact#AccountId- Display a child Account on a parent Account page: Account#ParentId
|
| Related Object(s) | Specifies multiple related objects to display in a single component. | Format: RelatedObjectApiName#LookupFieldApiName or RelatedObjectApiName#LookupFieldApiName#RelatedObjectFieldAPIName. Separate multiple objects with a semicolon ;.Examples: - Display related Contacts and Cases on an Account page: Contact#AccountId;Case#AccountId- Display Opportunity and Contract records related to an Account, showing a specific field: Opportunity#AccountId#Name;Contract#AccountId#ContractNumber
|
| Related Object Field API Name | Specifies the related record field to display. | Supports custom label expression: {!$Label.customLabelName}
|
| Maximum Number of Records | Sets the maximum number of related records to display. | - Example: 5 → Displays only the first 5 related records.- Use when you want to limit visible results for performance or UI clarity. |
| Sort By Field | Specifies the related object's field API name used for sorting records. | - Example: CreatedDate → Sorts by creation date.- Example: Name → Sorts alphabetically by record name. |
| Sort Order | Specifies sorting order. | Available values: Ascending, Descending |
| Height | Sets the component’s height. | - Example: 500px → Component will be 500 pixels high.- Use when you want to control the visible scroll area. |
| Use Fullscreen Image Viewer | Enables/disables fullscreen image viewing. | - Example: Enabled → Clicking an image opens it in fullscreen. - Disable if fullscreen mode is not desired. |
| Fullscreen Viewer Padding | Adds padding for fullscreen view. | Default: 90px 0 0 0
|
| Enable Action | Enables/disables Tag Action. | Enabled by default on SharinPix Album. More info: Tag Action article |
| Enable Image Sync | Enables/disables Image Sync. | Enabled by default on SharinPix Album. Additional setup required — see Setup SharinPix Image Sync article |
| Enable Toast | Enables/disables toast message on successful image upload. | - Example: Enabled → Shows “Image uploaded successfully” after upload. - Disable if you want no success pop-up. |
| Auto Refresh View | Enables/disables automatic view reload. | - Example: Enabled → List refreshes automatically after an upload. - Disable for manual refresh control. |
| Custom Permission ID or Name | Specifies a custom Sharinpix permission’s ID or Name. | - Use to restrict certain features to specific user groups using SharinPix Permissions. |
Demo
The example below demonstrates the SharinPix Related Record Albums (LWC) component showing the related Contact's Name and Case's Number on an Account page:
0 Comments
Add your comment