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 Aura Components as Custom Tabs in a Lightning Experience 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 Experience 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
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
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 an Aura component to allow it to be used as a custom tab in Lightning Experience, the Salesforce mobile app, and Salesforce mobile web.

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

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.