Lightning Web Component
UI Related List API
Descriptor
lightning-ui-related-list-apiTargets
Lightning Experience, Experience Builder Sites, Salesforce Mobile App
The lightning/uiRelatedListApi module includes wire adapters to get related list metadata and record data. The wire adapters are:
- getRelatedListInfo
- getRelatedListsInfo
- getRelatedListRecords
- getRelatedListCount
- getRelatedListRecordsBatch
- getRelatedListInfoBatch
For this module's specification and examples, see the Lightning Web Components Developer Guide.
LWC Recipes
The LWC Recipes GitHub repository contains code examples for Lightning Web Components that you can test in an org.
For a recipe that uses lightning/uiRelatedListApi, see the c-wire-related-list component in the LWC Recipes repo.
