Lightning Aura Components Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Aura Component Bundle Design Resources
Basic Navigation
Add Links to Lightning Pages from Your Custom Components
Add Query Parameters
Navigate to a Record Create Page with Default Field Values
Navigate to a Web Page
Migrate to lightning:isUrlAddressable from from force:navigateToComponent
pageReference Types
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Use Aura and Lightning Web Components Outside of Salesforce with Lightning Out (Beta)
Developing Secure Code
Testing Components
Navigate Across Your Apps with Page References
The pageReference JavaScript object represents
a URL for a page. You can use a pageReference instead of
parsing or creating a URL directly. This approach helps you avoid broken navigation if
Salesforce changes URL formats in the future.
These navigation resources are supported only in Lightning Experience, Experience Builder sites, and the Salesforce mobile app. They’re not supported in other containers, such as Lightning Components for Visualforce, or Lightning Out. This is true even if you access these containers inside Lightning Experience or the Salesforce mobile app.
-
Basic Navigation
The pageReference JavaScript object represents a URL for a page. You can use a pageReference instead of parsing or creating a URL directly. This approach helps you avoid broken navigation if Salesforce changes URL formats in the future. -
Add Links to Lightning Pages from Your Custom Components
To link to Lightning Experience pages, use lightning:formattedUrl in your custom component. The lightning:formattedUrl component displays a URL as a hyperlink. -
Add Query Parameters
To add query parameters to the URL, update the PageReference state property. The key-value pairs of the state property are serialized to URL query parameters. The query parameters describe the page and form a more specific URL that the user can save or bookmark. -
Navigate to a Record Create Page with Default Field Values
The lightning:pageReferenceUtils component provides utilities for encoding default field values into a string. Pass this string into the pageReference.state.defaultFieldValues attribute on standard__objectPage page reference types. -
Navigate to a Web Page
The navigation service supports different kinds of pages in Lightning. Each page reference type supports a different set of attributes and state properties. -
Migrate to lightning:isUrlAddressable from from force:navigateToComponent
The pageReference JavaScript object represents a URL for a page. You can use a pageReference instead of parsing or creating a URL directly. This approach helps you avoid broken navigation if Salesforce changes URL formats in the future. -
pageReference Types
To navigate in Lightning Experience, Experience Builder sites, 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. For Experience Builder sites, depending on the page type, the pageReference property requirements can differ between LWR sites and Aura sites.