lightning__RecordPage Target

Enables a component to be used on a record page in Lightning App Builder.

Configures the component for an app home page and defines component properties. The targetConfigs tag contains at least one targetConfig tag.

Configures an app home page with this attribute.

AttributeDescriptionRequired
targetsSpecify one or more page types in the targets attribute, such as <targetConfig targets="lightning__Inbox"> or <targetConfig targets="lightning__Inbox,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 and can include an objects tag.

Specifies a public property of a component that can be set in Lightning App 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
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 Lightning App Builder.
labelStringDisplays as a label for the attribute in Lightning App 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 Lightning App 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.

Limits the component to a set of one or more objects. If you don’t use this tag set, the component supports all supported objects. This tag set works only inside a parent targetConfig that’s configured for lightning__RecordPage.

Specify the objects tag set only one time inside a targetConfig set.

Use objects with the object tag.

Defines which objects the component is supported for. Use one object tag for each supported object.

The object tag doesn't support external objects.

See the User Interface API Developer Guide for the list of supported objects.

A set of one or more form factors or devices that the component supports. Specify the supportedFormFactors tag set one time inside a targetConfig set. The supportedFormFactors tag contains at least one supportedFormFactors tag.

Defines which form factor or device the component supports. Use one supportedFormFactor tag for each supported form factor.

The supportedFormFactor tag supports this attribute.

AttributeTypeDescriptionRequired
typeStringDevice form factor on which the component displays. Valid values are:
  • Large—Represents the desktop form factor.
  • Small—Represents the phone form factor.
Yes

We strongly recommend including supported form factor information in the configuration file. See Configure Your Component for Different Form Factors.

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

Bind the height property in your template.

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

See Also