Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
Debugging
Reference
Reference Doc App
Supported aura:attribute Types
aura:application
aura:component
aura:dependency
aura:event
aura:interface
aura:method
aura:set
Component Reference
Interface Reference
Event Reference
System Event Reference
Supported HTML Tags
PDF

Newer Version Available

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

Interface Reference

There are several interfaces that a component can implement to allow usage in different contexts within Lightning Experience or Salesforce1. A component can implement multiple interfaces.
clients:hasItemContext
Enables a component to be assigned to an email’s or a calendar event’s item attributes in Lightning for Outlook. For more information, see Create Components for Lightning for Outlook (Beta).
force:appHostable
Enables a component to be used as a custom tab in Lightning Experience or Salesforce1. For more information, see Add Lightning Components as Custom Tabs in Lightning Experience.
force:hasRecordId
Enables a component to be assigned the ID of the currently displaying record. Useful for components invoked in a context associated with a specific record, such as record page components or custom object actions. For more information, see Configure Components for Lightning Experience Record Pages.
force:hasSObjectName
Enables a component to access the API name of the object of the currently displaying record. Useful for record page components. For more information, see Configure Components for Lightning Experience Record Pages.
force:lightningQuickAction
Enables a component to display in a panel with standard action controls, such as a Cancel button. These components can also display and implement their own controls, but should handle events from the standard controls. If you implement force:lightningQuickAction, you can’t implement force:lightningQuickActionWithoutHeader within the same component. For more information, see Configure Components for Custom Actions.
force:lightningQuickActionWithoutHeader

Enables a component to display in a panel without additional controls. The component should provide a complete user interface for the action. If you implement force:lightningQuickActionWithoutHeader, you can’t implement force:lightningQuickAction within the same component. For more information, see Configure Components for Custom Actions.