Last updated
Was this helpful?
The Navigate interaction lets you control what happens when a user clicks on a button, link, or other interactive element within an Avonni Dynamic Component. You can define the destination, whether it's another page within your Salesforce org, an external website, or a specific record or object.
The Navigate interaction is a powerful way to create a seamless user experience by guiding users to the appropriate locations within your application. Instead of just displaying static content, you can make your components interactive and connect them to other parts of Salesforce.
You can typically add the Navigate interaction to components that support user interaction, such as:
Buttons
Button Groups
Button Menus
Button Icons
Data Table (row actions, header actions)
List Items
And Potentially others.
The core of the Navigate interaction is the "Page Reference Type." This determines what kind of destination you're linking to. Avonni Dynamic Components support a wide range of page reference types:
App: Navigate to a specific Lightning App.
Knowledge Article: Navigate to a specific Knowledge Article.
Lightning Component: Navigate to a custom Lightning Component.
Login Page: Navigate to the login page of an Experience Builder site.
Named Page (Standard): Navigate to standard Salesforce pages (like Home, Chatter, etc.).
Navigation Item Page: Navigate to a page associated with a custom tab.
Object Page: Navigate to a standard or custom object page (list view, new record page, etc.).
Record Page: Navigate to a specific record's detail page.
Web Page: Navigate to an external website (URL).
The following sections detail how to configure each page reference type.
Use this to navigate to a Lightning App.
Configuration:
Page Reference Type: App
App Target: Enter either:
The App ID (e.g., 06mRM0000008dNrYAI). You can find the App ID in the URL when editing the app in Setup > App Manager. The URL will look like: /lightning/app/06mRM0000008dNrYAI.
The App Developer Name (e.g., standard__LightningSales). This is the API name of the app.
Example URLS (For Information Only - you don't enter these URLs):
To App Homepage (using App ID): /lightning/app/06mRM0000008dNrYAI
To Object Home within App (using App ID): /lightning/app/06mRM0000008dNrYAI/o/Case/home
To App Homepage (using Developer Name): /lightning/app/standard__LightningSales
To Object Home within the App (using the Developer Name): /lightning/app/standard__LightningSales/o/Case/home
Use this to navigate to a specific Knowledge Article.
Configuration:
Page Reference Type: Knowledge Article
Article Type: Enter the API name of the Knowledge Article type (e.g., Knowledge__kav).
URL Name: Enter the URL Name of the specific article you want to link to.
Important Note: In Experience Builder sites, the Article Type is ignored; only the URL Name is used.
Use this to navigate to a custom Lightning Web Component (LWC) or Aura component.
Configuration:
Page Reference Type: Lightning Component
Component Name: Enter the component's API name in the format namespace__componentName (e.g., c__myComponent for a component in the default namespace, or myNamespace__myComponent for a component in a managed package).
Use this to navigate to the login or logout page of an Experience Builder site.
Configuration:
Page Reference Type: Login Page
Action Name: Choose either:
login: To go to the login page.
logout: To log the user out.
Use this to navigate to standard Salesforce pages.
Configuration:
Page Reference Type: Named Page (Standard)
Page Name: Choose from the available standard page names:
home
chatter
today
dataAssessment
filePreview
Use this to navigate to a page associated with a custom tab.
Configuration:
Page Reference Type: Navigation Item Page
Tab API Name: Enter the API name of the custom tab (e.g., My_Custom_Tab__c).
Use this to navigate to standard or custom object pages without specifying a particular record. This differs from the "Record Page" option, which navigates to a specific record. Here, you're navigating to object-level views.
Configuration
Page Reference Type: Object Page
Object API Name: Enter the API name of the standard or custom object (e.g., Account, Case, My_Custom_Object__c).
Action Name: Choose the action:
home: Navigate to the object's home page (usually a list view).
list: Navigate to a specific list view. Note: To specify which list view, you often need additional configuration (which may depend on the specific Avonni component). Refer to the component's documentation for details.
new: Navigate to the "new record" creation page for the object
Use this to navigate a specific record's detail, edit, or clone page within Salesforce.
Page Reference Type: Record Page
Object API Name: Enter the API name of the object to which the record belongs (e.g., Account, Contact, My_Custom_Object__c). This determines the type of record you're linking to.
Record ID: For the Record ID, select the field that includes the record's ID. The available fields are determined by your Dynamic Component's Target Object API Name setting, or you can choose a variable containing a Record ID. A typical example is @AccountsTable.firstSelectedRow.Id to use the ID from a selected row in a Data Table
Action Name: Choose the action:
view: Go to the record's detail page.
edit: Go to the record's edit page.
clone: Go to the "clone record" page.
The dropdown will initially show ID fields from the object specified in the Object API Name setting, ensuring you select an ID field compatible with the target object.
Use this to navigate a website by specifying a fixed URL or dynamically referencing a field containing a URL.
Page Reference Type: Web Page
URL: You have two options:
Static URL: Enter the full URL of the website directly (e.g., https://www.example.com). This will always navigate to the same website.
Dynamic URL (from a Field): Select a field from the component's context that contains the URL. This formula field typically constructs the URL based on other data. For example, you might have a formula field on an Account object that generates a URL to the Account's website. You could then select that formula field here. This lets the destination URL change dynamically based on the viewed or selected record.
When using the Navigate interaction with the Object Page and an action name of new you can automatically populate fields on a new record creation page. You can set variables for the new record page to be opened.
