Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Aura Component Bundle Design Resources
Use Aura Components in Lightning Experience and the Salesforce Mobile App
Navigate Across Your Apps with Page References
Basic Navigation
Add Links to Lightning Pages from Your Custom Components
Add Query Parameters
Navigate to a Web Page
Migrate to lightning:isUrlAddressable from force:navigateToComponent
pageReference Types
Get Your Aura Components Ready to Use on Lightning Pages
Use Aura Components in Community Builder
Use Aura Components with Flows
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Add Aura Components to Any App with Lightning Out (Beta)
Lightning Container
Communicating with Events
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Using Apex
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

pageReference Types

To navigate in Lightning Experience, Lightning Communities, or the Salesforce mobile app, define a PageReference object. The pageReference type generates a unique URL format and defines attributes that apply to all pages of that type.
The following types are supported.
  • Lightning Component (must implement lightning:isUrlAddressable)
  • Knowledge Article
  • Named Page
  • Navigation Item Page
  • Object Page
  • Record Page
  • Record Relationship Page
  • Web Page

PageReference objects are supported on a limited basis for Lightning Communities, as noted for each type.

Note

Lightning Component Type

A Lightning component that implements the lightning:isUrlAddressable interface, which enables the component to be navigated directly via URL.

Type
Experience
Lightning Experience, Salesforce Mobile App
Type Attributes
Property Type Description Required?
componentName String The Lightning component name in the format namespace__componentName. Y
Example
URL Format

Knowledge Article Page Type

A page that interacts with a Knowledge Article record.

Type
Experience
Lightning Experience, Lightning Communities, Salesforce Mobile App
Type Attributes
Property Type Description Required?
articleType String The ArticleType API name of the Knowledge Article record.

In Communities, articleType is ignored.

 Y
urlName String The value of the urlName field on the target KnowledgeArticleVersion record. The urlName is the article's URL. Y
Example
URL Format

Named Page Type

A standard page with a unique name. Only home, chatter, today, and dataAssessment are supported.

Type
Experience
Lightning Experience, Lightning Communities, Salesforce Mobile App
Type Attributes
Property Type Description Required?
pageName String The unique name of the page.
In Lightning Experience and the Salesforce mobile app, possible values are:
  • home
  • chatter
  • today
  • dataAssessment
  • filePreview

In Communities, the value for pageName is the URL value for a supported page. For instance, the default URL value for the Account Management page is /account-management, so the value for pageName would be account-management.

The value of home is reserved for the landing page of any community in your org.

Supported pages in Communities are:
  • Home
  • Account management
  • Contact support
  • Error
  • Top Articles
  • Topic Catalog
  • Custom pages
 Y
Example
URL Format

Navigation Item Page Type

A page that displays the content mapped to a CustomTab. Visualforce tabs, web tabs, Lightning Pages, and Lightning Component tabs are supported.

Type
Experience
Lightning Experience, Salesforce Mobile App
Type Attributes
Property Type Description Required?
apiName String The unique name of the CustomTab. Y
Example
URL Format

Object Page Type

A page that interacts with a standard or custom object in the org and supports standard actions for that object.

The standard__objectPage type replaces the force:navigateToObjectHome and the force:navigateToList events.

Note

Type
Experience
Lightning Experience, Lightning Communities, Salesforce Mobile App
Type Attributes
Property Type Description Required?
actionName String The action name to invoke. Valid values include home, list, and new.

In Communities, list and home are the same.

 Y
objectApiName String The API name of the standard or custom object. For custom objects that are part of a managed package, prefix the custom object with ns__. Y
Standard Object Example
Navigate to a Specific List View Example
URL Format

Record Page Type

A page that interacts with a record in the org and supports standard actions for that record.

The standard__recordPage type replaces the force:navigateToSObject event.

Note

Type
Experience
Lightning Experience, Lightning Communities, Salesforce Mobile App
Type Attributes
Property Type Description Required?
actionName String The action name to invoke. Valid values include clone, edit, and view.

Communities doesn’t support the values clone or edit.

 Y
objectApiName String The API name of the record’s object. Optional for lookups.
recordId String The 18 character record ID. Y
Example
URL Format

Record Relationship Page Type

A page that interacts with a relationship on a particular record in the org. Only related lists are supported.

The standard__recordRelationshipPage type replaces the force:navigateToRelatedList event.

Note

Type
Experience
Lightning Experience, Salesforce Mobile App
Type Attributes
Property Type Description Required?
actionName String The action name to invoke. Only view is supported. Y
objectApiName String The API name of the object that defines the relationship. Optional for lookups.
recordId String The 18 character record ID of the record that defines the relationship. Y
relationshipApiName String The API name of the object’s relationship field
Example
URL Format

Web Page

An external URL.

The standard__webPage type replaces the force:navigateToURL event.

Note

Type
Experience
Lightning Experience, Salesforce Mobile App
Attributes
Property Type Description Required
url String The URL of the page you are navigating to. Yes
Example
To replace the current page with this URL in your browser’s session history, set replace to true. The current page is not saved in session history, meaning the user can’t navigate back to it. The replace attribute is ignored for external links.
URL Format
A web page opens as is in a new tab, so it doesn’t have a URL format.