For the complete documentation index, see llms.txt. This page is also available as Markdown.

Target Page Object

The Target Page Object tells your Dynamic Component which Salesforce object it's working with — for example, Account, Contact, Opportunity, or My_Custom_Object__c. This setting is what connects the component to live record data when it's placed on a record page


How to Set It

You can set the Target Page Object in two places:

When creating a new component

The creation dialog includes a Target Page Object dropdown. Select the object before finishing setup.

In an existing component

Open the component in the Component Builder, click the Settings icon (⚙️, top-right), and select the object from the Target Page Object dropdown. Save when done.


Why is the Target Page Name Important?

Effect
Details

Populates the Fields tab

The left-panel Fields tab loads all fields from the selected object, letting you drag fields directly onto the canvas as data-bound components.

Enables $Component.record

On a record page, when the Target Page Object matches the page's object type, the $Component.record variable becomes available — giving you direct access to field values like $Component.record.Name or $Component.record.Id.

Simplifies related data

With $Component.record.Id available, you can easily filter queries to show related records — for example, Contacts belonging to the current Account.


When to Use the Target Page Name

Set the Target Page Object whenever your component is placed on a record page and needs access to that record's data — Account pages, Contact pages, Opportunity pages, and so on. This covers the large majority of use cases.


When You Might Not Need It

If your component doesn't need a specific record's context — for example, a dashboard on an App Page pulling org-wide data — you can leave this unset and use an Avonni Query Data Source to fetch data directly. Similarly, if a component receives a record ID as an input variable (such as when launched in a modal), you may not need the Target Page Object for data access, though setting it still helps populate the Fields tab.


Last updated

Was this helpful?