lightning__EnablementProgram Target

Enables a component to be used in Program Builder as a custom exercise type for an Enablement program. Components appear in the Custom Items section of the Components list in the Program Builder palette.

Configures the component for a custom item on an Enablement program and defines component properties. The targetConfigs tag contains at least one targetConfig tag.

Configures a custom item for an Enablement program with this attribute.

AttributeDescriptionRequired
targetsSpecify one or more page types in the targets attribute, such as <targetConfig targets="lightning__EnablementProgram"> or <targetConfig targets="lightning__EnablementProgram,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 the properties of the Program Builder's property sheet for a custom item. Use the property tag with these attributes.

AttributeTypeDescriptionRequired
nameStringThe attribute name. Possible values are:
  • title
  • description
  • day
  • category
  • subCategory
  • customContent
Yes
typeStringThe data type. Possible values are:
  • Integer—Use for day.
  • Multilinetext—Use for description.
  • String—Use for title, category, subCategory, and customContent.
Yes
datasourceStringThe data source for customContent that shows the default picklist field on Program Builder's property editor. Supported only if the type attribute is String. You need to create a DynamicPickList Apex class to configure this property as a picklist. To customize the user interface for the Custom Content field, use the editor attribute and a Lightning web component instead of datasource.
defaultStringThe default value. Not applicable for customContent. Possible values are:
  • For category, valid value is Exercise.
  • For subCategory, provide the namespace prefix and developer name as the default value, using the format NamespacePrefix_DeveloperName. If the namespace prefix isn't available, provide the developer name.
  • (Optional) For title and description, the pre-filled label to be shown in the property sheet.
  • (Optional) For day, the minimum number of days the item is due. We recommend to set this to 1.
editorStringTo customize the Custom Content field on Program Builder's property editor, use the editor attribute and a Lightning web component instead of the datasource attribute.
labelStringThe label as displayed in the property sheet. Applies to these properties:
  • title
  • description
  • day
  • customContent
maxIntegerMaximum value accepted for the property. Possible values are:
  • For title, the maximum character length. The maximum allowed is 80 characters. Set this to 80 or less.
  • For description, the maximum character length. The maximum allowed is 350 characters. Set this to 350 or less.
  • For day, the maximum number of days until the item is due, relative to the program's start date. The maximum is 365. Set this to 365 or less.
minIntegerMinimum value accepted for the property. Possible values are:
  • For day, the minimum number of days until the item is due, relative to the program's start date. The minimum is 1, the day the exercise is assigned.
  • (Optional) For title and description, the minimum character length.
requiredBooleanSpecifies whether the attribute is required. The default value is false.

See Also