`lightningStatic__Email` Target

Enables a component to be used in Email Content Builder.

Syntax

1<?xml version="1.0" encoding="UTF-8"?>
2<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <apiVersion>58.0</apiVersion>
4    <isExposed>true</isExposed>
5    <targets>
6        <target>lightningStatic__Email</target>
7    </targets>
8    <targetConfigs>
9        <targetConfig targets="lightningStatic__Email">
10            <property name="htmlValue" type="String" required="true"/>
11            <property name="paddingTop" type="Integer" min="0" max="600"/>
12        </targetConfig>
13    </targetConfigs>
14</LightningComponentBundle>

targetConfigs

Configures the component for Email Content Builder and defines component properties. The targetConfigs tag contains at least one targetConfig tag.

targetConfig

Configures a page type with this attribute.

Attribute	Description	Required
`targets`	Specify one or more page types in the `targets` attribute, such as `<targetConfig targets="lightningStatic__Email">` or `<targetConfig targets="lightningStatic__Email,lightning__AppPage">`. The `targets` attribute value must match one or more of the page types that you listed under `<targets>`.	Yes

The targetConfig tag includes at least one property tag.

property

Specifies a public property of a component that can be set in Email Content Builder. The component author defines the property in the component’s JavaScript class using the @api decorator. See the Usage section.

Use the property tag with these attributes.

Attribute	Type	Description	Required
`name`	String	The attribute name. This value must match the property name in the component’s JavaScript class.	Yes
`type`	String	The attribute’s data type. The following values are valid for all targets. Make sure that this value matches the type assigned to the property in the component’s JavaScript module. If the types don’t match, the value in the configuration file takes precedence. `Boolean` `Integer` `String` `Color`—Displays a color selector. Use the `default` attribute to specify RGBA, RGB, or hex strings. For example: `<property type="Color" name="backgroundColor" default="rgba(0, 255, 255, 1)" />`. `HorizontalAlignment`—Displays a horizontal alignment selector. Use the default attribute to specify a `right`, `left`, or `center` alignment value. `VerticalAlignment`—Displays a vertical alignment selector. Use the default attribute to specify a `top`, `middle`, or `bottom` alignment value.	Yes
`datasource`	String	Renders a field as a picklist, with static values. Supported only if the `type` attribute is `String`. For example: `datasource="value1,value2,value3"`. You can also set the picklist values dynamically using an Apex class, such as: `datasource="apex://MyCustomPickList"`. For more information, see Create Dynamic Picklists for Your Custom Components.
`default`	String	The default value for the attribute.
`description`	String	Displays as an i-bubble for the attribute in Email Content Builder.
`label`	String	Displays as a label for the attribute in Email Content Builder.
`max`	Integer	The maximum allowed value for an attribute of type `Integer`.
`min`	Integer	The minimum allowed value for an attribute of type `Integer`.
`placeholder`	String	Input placeholder text for the attribute when it displays in Email Content Builder. This text is the ghost text in text fields and text areas before a user starts typing. Supported only if the type attribute is `String`.
`required`	Boolean	Specifies whether the attribute is required. The default value is `false`.

Usage

To expose a component property in Email Content Builder, define the property in the component’s JavaScript class using the @api decorator.

1import { LightningElement, api } from "lwc";
2export default class CustomEmailTemplate extends LightningElement {
3  @api paddingTop;
4
5  get topPadding() {
6    const paddingTop = this.paddingTop ? `padding-top: ${this.paddingTop}px;` : "";
7    return `${paddingTop}`;
8  }
9}

Bind the paddingTop property in your template.

1<template>
2  <p style={topPadding}>Your content here</p>
3</template>

The component renders with a style value that a user provides in the Property Editor.

1<p style="padding-top: 200px;">Your content here</p>

See Also