Newer Version Available

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

Event Reference

Use out-of-the-box events to enable component interaction within Lightning Experience or the Salesforce app, or within your Lightning components. For example, these events enable your components to open a record create or edit page, or navigate to a record.
The reference documentation is available in the Component Library at the following links.
  • As an unauthenticated experience at developer.salesforce.com/docs/component-library
  • As an authenticated experience at https://<myDomain>.lightning.force.com/componentReference/suite.app, where <myDomain> is the name of your custom Salesforce domain

Events belong to different namespaces, including:

force
Provides events that are handled by Lightning Experience and the Salesforce app.
forceChatter
Provides events that are handled by Chatter publisher.
forceCommunity
Provides events that are handled by Communities.
lightning
Provides events that are handled by Lightning Experience, the Salesforce app, and Communities.
ltng
Provides events that send the record ID or generic message to another component.
ui
Provides events that are handled by the legacy ui components.
wave
Provides events that are handled by Analytics.
If you fire one of these force or lightning events in your Lightning apps or components outside of the Salesforce app or Lightning Experience:
  • You must handle the event by using the <aura:handler> tag in the handling component.
  • Use the <aura:registerEvent> or <aura:dependency> tags to ensure that the event is sent to the client, when needed.