What's New?
The new Component Reference adopts a similar look-and-feel of other Salesforce developer documentation. At the same time, it maintains some features of the legacy site by presenting the component information on separate tabs. The main documentation is now on a Develop tab, with the component API descriptions on a Specifications tab. The Examples tab presents running code examples along with the component code.
The legacy Component Reference was available as part of the Component Library and is no longer updated.
Here are a few differences between the new Component Reference and the legacy Component Reference.
| New Component Reference | Legacy Component Reference | |
|---|---|---|
| View component categories | Use the overview pages such as Components, API Modules, Legacy Components to see the categories of components. | On the Overview page, filter by categories, targets, or namespaces. |
| View experiences that support the component | See the For Use In section on each component page, which describes where you can use the component. For example, in Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Standalone Lightning App, and so on. | See the Target panel at the top of each component page. |
| Switch between Aura and LWC | Switch from the Aura version of a component by clicking the LWC equivalent that's presented before the For Use In section. | Switch between the versions of a component by clicking the View as Aura Component and View as Lightning Web Component button. |
| View examples | LWC examples render using the latest release. Some components, such as lightning-record-form and lightning-input-field, require Salesforce data. They can't be used outside an org and don't have an Example page. | Examples use base components and Salesforce Lightning Design System (SLDS) from an older release, before newer components like lightning-alert and lightning-modal. Some components, such as lightning-record-form and lightning-input-field, require Salesforce data. They can't be used outside an org and don't have an Example page. |
| View documentation | Develop tabs display documentation with improved structure and navigation, right-side links to topics, formatted in-doc code samples with copy buttons and dark mode. | Documentation tabs display documentation with little formatting or navigation features. |
| View specification | Same as legacy Component Reference, but more reliable display for Type and Default values. The Access field is not displayed because all documented components/modules have global access. Support status is included in the documentation instead of Specification. | Specification pages display attributes, methods, slots, and events information. Display of values for Type and Default is unreliable. |
| Modify LWC examples | Modifying examples isn't supported currently. | Modify examples and run them in real time. However, examples use an older release of base components and don't support newer components, attributes, and methods. |
| View Aura examples | Aura examples are displayed as an image. Aura examples aren't interactive. | Aura examples are interactive. |
You can't display custom Aura component documentation for your org in the new Component Reference. The new site is only available as a web site, not an application that can run in your org. The Component Library app will continue to run in your org so you can view your custom Aura component doc there.