Skip Navigation

Lightning Web Components Developer Guide

`lightning/stateManagerRelatedListsInfo`

This state manager gets the metadata for RelatedLists in an object’s default layout.

Syntax

RelatedLists details depend on a parent object developer (API) name, and optionally a record type ID.

1import { LightningElement } from 'lwc';
2import smRelatedListsInfo from "lightning/stateManagerRelatedListsInfo";
3
4export default class Example extends LightningElement {
5
6  const myRelatedListsInfo = smRelatedListsInfo({
7    parentObjectApiName: string,
8    recordTypeId?: string
9  });
10}

Configuration Functions

setConfig(): Provide the entire configuration as an object. This function is equivalent to the factory function when you create the state manager.
setParentObjectApiName(): Set the API name of a parent object that you want to get related lists for, like an Account.
setRecordTypeId(): Set the ID of the parent record type.

State Manager Properties

status: The current status of the state manager. See status for details.
data: When status is "loaded", a Related List Summary Collection.
error: When status is "error", this property contains details. See error for details.

See Also

getRelatedListsInfo wire adapter
User Interface API Developer Guide: Get Related Lists for an Object