Salesforce1 Mobile App Developer Guide

Introduction
About This Book
Setting Up Your Work Environment
Salesforce1 Administration
Developing for Salesforce1
Welcome to Salesforce App Cloud Development
Designing Mobile-First User Interfaces
Extending Salesforce1 with Visualforce Pages
Adding Functionality with Visualforce Custom Actions
Integrating Your Web Applications in Salesforce1 with Force.com Canvas
Calling Quick Actions from the API
Extending the User Interface with Lightning Pages
What Is a Lightning Page?
Lightning Pages
Lightning Pages: The Big Picture
Deploying a Lightning Page
Lightning Page Tabs
Making Your Lightning Page Available in Salesforce1
Tell Me More: Lightning Pages
Development Guidelines and Best Practices
Learning More
PDF

Lightning Pages

A Lightning Page consists of a list of regions containing ComponentInstances. A ComponentInstance contains properties for an instance of a particular component, such as which Lightning component the instance points to, and a set of name-value pairs representing a subset of the Lightning component’s attributes.

Available Standard Lightning Components

Not every Lightning component can be specified in a ComponentInstance. Even among those that are allowed, not all their attributes can be specified. Currently, these Lightning components are supported for use across all types of Lightning Pages.

flexipage:filterListCard
Points to a list view and displays the first few records from that view.
The flexipage:filterListCard component supports all list views that are associated with standard and custom objects except:
  • Activity
  • ContentVersion (Files)
  • Task
  • User
  • UserProfile
flexipage:recentItems
A list of most recently used items that supports these objects, based on the specified properties:
  • All custom objects
  • All standard objects for which both of these conditions are true:
    • A compact layout is defined for the object.
    • The object is tracked in the most recently used objects list.
    If an object is tracked in the most recently used objects list, one or both of the LastViewedDate or LastReferencedDate fields are present.
The Recent Items component doesn’t support these objects:
  • ContentVersion (Files)
  • User
  • UserProfile
flexipage:reportChart
Use the Report Chart component to include a chart from a report in your Lightning Page.
Properties:
  • label: If you leave this property blank, the component label is taken from the label of the report instead.
  • reportName: The API name of the report.

This component is supported in API version 32.0 and later. It doesn’t work with reports that are located in the My Personal Custom Reports folder. Report Chart components that refer to reports in the Unfiled Public Reports folder aren’t deployable if you include them in a package.

flexipage:richText
Use the Rich Text component to add text and simple HTML markup to your Lightning Page.
Properties:
  • richTextValue: The HTML or text to display

    JavaScript, CSS, iframes, and other advanced markup aren’t supported. To use advanced HTML elements in a component, we recommend using a Visualforce page component or a custom Lightning component.

    Note

The Rich Text component is limited to 4,000 characters. This component is supported in API version 32.0 and later.

flexipage:tab
Use the Tabs component to add a set of tabs to a region of your Lightning Page. Choose from a set of standard tabs or create custom tabs to enhance record pages for your Lightning Experience users.

You can place up to 25 tabs in a Tabs component. This component is supported in API version 36.0 and later.

Use the Report Chart component to include a chart from a report in your Lightning Page.
flexipage:visualforcePage
Use the Visualforce Page component to include a Visualforce page in your Lightning Page.
Properties:
  • label: The component label. If you leave this property blank, the component label is taken from the label of the Visualforce page.
  • pageName: The API name of the Visualforce page to render.
  • height: The height of the Visualforce page in pixels. This value must be a whole number, and not negative. If this property is left blank, a default height of 300 pixels is assigned.

This component is supported in API version 32.0 and later.

To appear in Salesforce1, the Visualforce page must have the Available for Salesforce mobile apps and Lightning Pages option selected. This option is available for pages that are set to API version 27.0 and later.

salesforceIdentity:appLauncherDesktop
The App Launcher displays a user’s available Salesforce apps and any connected apps the administrator configures. Users navigate between apps using the App Launcher.

This component is supported in API version 35.0 and later.

Contact Salesforce to enable the App Launcher component for the Lightning App Builder in your organization.

wave:waveDashboard

Use the Wave Dashboard component to include Wave Analytics dashboards in your Lightning Page. This component is supported for desktop only.

Properties:
  • dashboard: The name of the dashboard to display.
  • height: The height of the dashboard in pixels. This value must be a whole number, and not negative. If this property is left blank, a default height of 300 pixels is assigned.
  • filter: The filters to apply to the dashboard at run time, in JSON. For example, {datasetDeveloperName1:{field1:[value]},datasetDeveloperName1:{field1:[value1,value2],field2:["value3, with comma"]}}.
  • showTitle: Enables the dashboard’s title to appear.
  • openLinksInNewWindow: Whether to open a link from the dashboard to another asset in the same window, replacing the dashboard, or in a new window.
  • hideOnError: Whether to hide the Wave dashboard when an error occurs.

Contact Salesforce to enable the Wave Dashboard component for the Lightning App Builder.