Book Image

Learning Salesforce Lightning Application Development

By : Mohit Shrivatsava
Book Image

Learning Salesforce Lightning Application Development

By: Mohit Shrivatsava

Overview of this book

Built on the Salesforce App Cloud, the new Salesforce Lightning Experience combines three major components: Lightning Design System, Lightning App Builder, and Lightning Components, to provide an enhanced user experience. This book will enable you to quickly create modern, enterprise apps with Lightning Component Framework. You will start by building simple Lightning Components and understanding the Lightning Components architecture. The chapters cover the basics of Lightning Component Framework semantics and syntax, the security features provided by Locker Service, and use of third-party libraries inside Lightning Components. The later chapters focus on debugging, performance tuning, testing using Lightning Testing Services, and how to publish Lightning Components on Salesforce AppExchange.
Table of Contents (22 chapters)
Title Page
PacktPub.com
Foreword
Contributors
Preface
Index

Documenting your components using the auradoc file


The documentation can be written using the .auradoc file that is created every time you create a Lightning Component. The documentation for the Lightning Component is available at the https://<myDomain>.Lightning.force.com/componentReference/suite.app URL and any auradocs for custom components also appear at the same URL in your Salesforce instance. Note that <myDomain> is the domain name of your Salesforce instance.

 

As it currently has no documentation, you will see that the component docs for SearchApp look as follows:

Let's prettify it by adding the proper documentation. To start, let's add a description in the youtubesearch.auradoc file, as follows:

<aura:documentation>
 <aura:description>
      <p>An <code>SearchApp:youtubesearch</code> component provides a component with a search box to search across youtube</p>
   </aura:description>
   <aura:example name="ExampleName" ref=""...