lightning__HomePage Target
Enables a component to be used on a Home 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.
| Attribute | Description | Required |
|---|---|---|
targets | Specify one or more page types in the targets attribute, such as <targetConfig targets="lightning__HomePage"> or <targetConfig targets="lightning__HomePage,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 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.
| 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.
| 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 Lightning App Builder. | |
label | String | Displays as a label for the attribute in Lightning App 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 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. | |
required | Boolean | Specifies whether the attribute is required. The default value is false. |
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.
| Attribute | Type | Description | Required |
|---|---|---|---|
type | String | Device form factor on which the component displays. Valid values are:
| 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
- Configure a Component for Lightning App Builder
- XML Configuration File Elements
- Salesforce Help: Create an App Home Page with the Lightning App Builder