Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Aura Component Bundle Design Resources
Use Aura Components in Lightning Experience and the Salesforce Mobile App
Configure Components for Custom Tabs
Add Lightning Components as Custom Tabs in a Lightning Experience App
Add Lightning Components as Custom Tabs in the Salesforce App
Lightning Component Actions
Override Standard Actions with Aura Components
Navigate Across Your Apps with Page References
Get Your Aura Components Ready to Use on Lightning Pages
Use Aura Components in Community Builder
Use Aura Components with Flows
Add Components to Apps
Integrate Your Custom Apps into the Chatter Publisher
Using Background Utility Items
Use Lightning Components in Visualforce Pages
Add Aura Components to Any App with Lightning Out (Beta)
Lightning Container
Communicating with Events
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Using Apex
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
PDF

Newer Version Available

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

Add Lightning Components as Custom Tabs in the Salesforce App

Make your Lightning components available for Salesforce for Android, Salesforce for iOS, and Salesforce mobile web users by displaying them in a custom tab.
Available in: Salesforce Classic (not available in all orgs) and Lightning Experience
Available for use in: Contact Manager, Group, Professional, Enterprise, Performance, Unlimited, and Developer Editions

Create Lightning components using the UI in Enterprise, Performance, Unlimited, Developer Editions, or a sandbox.

User Permissions Needed
To create Lightning Component Tabs: Customize Application

To add a Lightning web component as a custom tab, wrap it in an Aura component. See Lightning Web Components Developer Guide.

Note

In the component you wish to add, include implements="force:appHostable" in your aura:component tag and save your changes.

1<aura:component implements="force:appHostable">

The appHostable interface makes the component available as a custom tab.

To create Aura components, use the Developer Console.

Include your components in the navigation menu by following these steps.

  1. Create a custom Lightning component tab for the component. From Setup, enter Tabs in the Quick Find box, then select Tabs.

    You must create a custom Lightning component tab before you can add your component to the navigation menu. Accessing your Lightning component from the full Salesforce site is not supported.

    Note

  2. Check your output by going to Salesforce mobile web. Your new menu item should appear in the navigation menu.

    By default, Salesforce mobile web is turned on for your org. For more information on using mobile web, see the Salesforce App Developer Guide.

    Note