Lightning 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)
Lightning Component Bundle Design Resources
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Newer Version Available
Using Components
You can use components in many different contexts. This section shows you
how.
-
Lightning Component Bundle Design Resources
Use a design resource to control which attributes are exposed to builder tools like the Lightning App Builder, Community Builder, or Cloud Flow Designer. A design resource lives in the same folder as your .cmp resource, and describes the design-time behavior of the Lightning component—information that visual tools need to display the component in a page or app. -
Use Lightning Components in Lightning Experience and the Salesforce Mobile App
Customize and extend Lightning Experience and the Salesforce app with Lightning components. Launch components from tabs, apps, and actions. -
Navigation in Lightning Experience and the Salesforce Mobile App Using 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. -
Get Your Lightning Components Ready to Use on Lightning Pages
Custom Lightning components don’t work on Lightning pages or in the Lightning App Builder right out of the box. To use a custom component in either of these places, you must configure the component and its component bundle so that they’re compatible. -
Use Lightning Components in Community Builder
To use a custom Lightning component in Community Builder, you must configure the component and its component bundle so that they’re compatible. -
Use Lightning Components with Flows
Customize the look-and-feel and functionality of your flows by adding Lightning components to them. Or wrap a flow in a Lightning component to configure the flow at runtime, such as to control how a paused flow is resumed. -
Add Components to Apps
When you’re ready to add components to your app, you should first look at the out-of-the-box components that come with the framework. You can also leverage these components by extending them or using composition to add them to custom components that you’re building. -
Integrate Your Custom Apps into the Chatter Publisher
Use the Chatter Rich Publisher Apps API to integrate your custom apps into the Chatter publisher. The Rich Publisher Apps API enables developers to attach any custom payload to a feed item. Rich Publisher Apps uses lightning components for composition and rendering. We provide two lightning interfaces and a lightning event to assist with integration. You can package your apps and upload them to AppExchange. A community admin page provides a selector for choosing which five of your apps to add to the Chatter publisher for that community. -
Using Background Utility Items
Implement the lightning:backgroundUtilityItem interface to create a component that fires and responds to events without rendering in the utility bar. -
Use Lightning Components in Visualforce Pages
Add Lightning components to your Visualforce pages to combine features you’ve built using both solutions. Implement new functionality using Lightning components and then use it with existing Visualforce pages. -
Add Lightning Components to Any App with Lightning Out (Beta)
Use Lightning Out to run Lightning components apps outside of Salesforce servers. Whether it’s a Node.js app running on Heroku, a department server inside the firewall, or even SharePoint, build your custom app with Lightning Platform and run it wherever your users are. -
Lightning Container
Upload an app developed with a third-party framework as a static resource, and host the content in a Lightning component using lightning:container. Use lightning:container to use third-party frameworks like AngularJS or React within your Lightning pages.