Lightning Components Developer’s Guide

Getting Started
Introduction
Quick Start
Before You Begin
Create a Standalone Lightning App
Create a Component for Salesforce1
Creating Components
Communicating with Events
Creating Apps
Debugging
Reference
PDF

Newer Version Available

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

Before You Begin

To work with Lightning apps and components , follow these prerequisites.
  1. Create a Developer Edition organization
  2. Register a Namespace Prefix
  3. Enable Lightning Components in Salesforce1

You can create Lightning components using the UI in Enterprise, Performance, Unlimited, Developer Editions or a sandbox. If you don’t plan to use a Developer Edition organization, you can go directly to Enable Lightning Components in Salesforce1. A namespace prefix is required if you plan to offer managed packages on the AppExchange. We're not using a namespace in this quick start tutorial.

Note

Create a Developer Edition Organization

To register a namespace prefix, you need a Developer Edition organization, or DE org for short. If you don’t have a DE org, create one by following these steps.

  1. In your browser, go to http://bit.ly/lightningguide.
  2. Fill in the fields about you and your company.
  3. In the Email field, make sure to use a public address you can easily check from a Web browser.
  4. Type a unique Username. Note that this field is also in the form of an email address, but it does not have to be the same as your email address, and in fact, it’s usually better if they aren’t the same. Your username is your login and your identity on developer.salesforce.com, so you’re often better served by choosing a username such as firstname@lastname.com.
  5. Read and then select the checkbox for the Master Subscription Agreement and then click Submit Registration.
  6. In a moment you’ll receive an email with a login link. Click the link and change your password.

Register a Namespace Prefix

Next, register a namespace prefix. Your namespace prefix must be globally unique across all Salesforce organizations. Namespace prefixes are case-insensitive and have a maximum length of 15 alphanumerical characters.

A namespace is not required to create Lightning components but it’s required if you plan to offer managed packages. If your org doesn't have a namespace, you can use the default namespace to access your components.

Note

To register a namespace prefix:
  1. From Setup, click Create | Packages.
  2. Click Edit.

    This button doesn’t appear if you’ve already configured your developer settings.

    Note

  3. Review the selections that are required for configuring developer settings, and then click Continue.
  4. Enter the namespace prefix you want to register.
  5. Click Check Availability to determine if the namespace prefix is already in use.
  6. If the namespace prefix that you entered isn’t available, repeat the previous two steps.
  7. Click Review My Selections.
  8. Click Save.

Your namespace is used as a prefix to the components and Apex classes you are creating. In addition, use the namespace to address any apps you create by accessing:

https://<mySalesforceInstance>.lightning.force.com/<namespace>/<appName>.app, where <mySalesforceInstance> is the name of the instance hosting your org; for example, na1.

Enable Lightning Components in Salesforce1

You must opt in to enable Lightning components in Salesforce1. Lightning components in standalone apps (.app resources) are available by default.

  1. From Setup, click Develop | Lightning Components.
  2. Select the Enable Lightning Components checkbox.

    This beta version of Lightning components in Salesforce1 doesn’t support Force.com Canvas apps in Salesforce1. Any Force.com Canvas apps in your organization will no longer work in Salesforce1 if you enable Lightning components.

    Warning

  3. Click Save.