Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Lightning Component Bundle Design Resources
Use Lightning 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 Lightning Components
Navigation in Lightning Experience and the Salesforce Mobile App Using Page References
Get Your Lightning Components Ready to Use on Lightning Pages
Use Lightning Components in Community Builder
Use Lightning 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 Lightning Components to Any App with Lightning Out (Beta)
Lightning Container
Communicating with Events
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Using Apex
Lightning Data Service
Testing Components with Lightning Testing Service
Debugging
Performance
Reference
PDF

Newer Version Available

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

Configure Components for Custom Tabs

Add the force:appHostable interface to a Lightning component to allow it to be used as a custom tab in Lightning Experience or the Salesforce mobile app.

Components that implement this interface can be used to create tabs in both Lightning Experience and the Salesforce app.

Example Component

1<!--simpleTab.cmp-->
2<aura:component implements="force:appHostable">
3
4    <!-- Simple tab content -->
5
6    <h1>Lightning Component Tab</h1>
7
8</aura:component>

The appHostable interface makes the component available for use as a custom tab. It doesn’t require you to add anything else to the component.