Newer Version Available

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

Differences with Other Documentation Sites

Here’s a breakdown on the differences between the Component Library and other doc sites, such as the legacy reference documentation app.

The Component Library is undergoing major enhancements to achieve parity with the other legacy sites. Meanwhile, we recommend that you refer to the respective sites for your documentation needs.

Component Library (Beta) Reference Documentation (reference.app) Reference Section in Lightning Components Dev Guide
Component documentation and code samples Checkmark icon indicating true (Documentation tab) Checkmark icon indicating true (Overview tab) Checkmark icon indicating true
Interactive examples Checkmark icon indicating true (Usage tab) Checkmark icon indicating true (Examples tab is not available for components in lightning namespace)
Lightning Design System support Checkmark icon indicating true
Components in custom namespaces and packages Checkmark icon indicating true Checkmark icon indicating true
JavaScript API Checkmark icon indicating true
Messaging component reference Checkmark icon indicating true (lightning:notificationsLibrary etc.)
System tags Checkmark icon indicating true (aura:method, aura:set, etc.)
Event documentation Checkmark icon indicating true
System event documentation Checkmark icon indicating true
Interface documentation Checkmark icon indicating true Checkmark icon indicating true Checkmark icon indicating true

Components in custom namespaces display both global and non-global attributes and methods. Components in managed and unmanaged packages display global attributes and methods only.

The Reference Documentation site is available in your org and as an open-source project at http://documentation.auraframework.org/. Not everything in the open-source site is available to you in your org with Lightning Components. If you find something in the open-source site that’s not available in the Component Library or Dev Guide, don’t use it as it’s not supported.

Note