`lightning__PropertyEditor` Target

Enables a component to be used as a custom property editor in an Experience Builder component. Reference it in a LightningTypeBundle or in an Experience Builder component’s js-meta.xml file.

Syntax

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata" fqn="alignmentCPE">
3   <apiVersion>58.0</apiVersion>
4   <isExposed>true</isExposed>
5   <masterLabel>Alignment Editor Component</masterLabel>
6   <targets>
7     <target>lightning__PropertyEditor</target>
8   </targets>
9</LightningComponentBundle>

Usage

To use this component as a custom property editor in a LightningTypeBundle, specify the component’s fully qualified name as a component override in the editor.json file.

1{
2  "editor": {
3    "componentOverrides": {
4      "alignment": {
5        "definition": "c/alignmentCPE"
6      }
7    }
8  }
9}

Alternatively, to use this component as a custom property editor for a component property, reference this component in the editor attribute of the property tag.

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata" fqn="customArticle">
3 <masterLabel>Custom Article</masterLabel>
4 <apiVersion>66.0</apiVersion>
5 <targets>
6   <target>lightningCommunity__Page</target>
7   <target>lightningCommunity__Default</target>
8 </targets>
9 <targetConfigs>
10  <targetConfig targets="lightningCommunity__Default">
11    <property  name="textAlignment" type="String" editor="c/alignmentCPE" label="Text Alignment"/>
12  </targetConfig>
13 </targetConfigs>
14</LightningComponentBundle>

See Also

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

lightning__PropertyEditor Target

Syntax

Usage

`lightning__PropertyEditor` Target