lightningStatic__Email Target

Enables a component to be used in Email Content Builder.

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

Configures a page type with this attribute.

AttributeDescriptionRequired
targetsSpecify 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.

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.

AttributeTypeDescriptionRequired
nameStringThe attribute name. This value must match the property name in the component’s JavaScript class.Yes
typeStringThe 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
datasourceStringRenders 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.
defaultStringThe default value for the attribute.
descriptionStringDisplays as an i-bubble for the attribute in Email Content Builder.
labelStringDisplays as a label for the attribute in Email Content Builder.
maxIntegerThe maximum allowed value for an attribute of type Integer.
minIntegerThe minimum allowed value for an attribute of type Integer.
placeholderStringInput 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.
requiredBooleanSpecifies whether the attribute is required. The default value is false.

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

Bind the paddingTop property in your template.

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

See Also