Lightning Aura Components Developer Guide

What Is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Create a Message Channel
Publish on a Message Channel
Subscribe to a Message Channel
Lightning Message Service Limitations
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

Create a Message Channel

To create a lightning:messageChannel component in your org, use the LightningMessageChannel metadata type and append it with __c. The message channel isn’t a custom object, it just uses the same suffix.

See LightningMessageChannel in the Metadata API Developer Guide (can be outdated or unavailable during release preview).

Note

To deploy a LightningMessageChannel into your org, create an SFDX project. Include the XML definition in the force-app/main/default/messageChannels/ directory. The LightningMessageChannel file name follows the format messageChannelName.messageChannel-meta.xml. To add it to your scratch org, run sfdx force:source:push. To add it to another type of org, such as a sandbox or a Developer Edition org, run sfdx force:source:deploy.