lightning__ECSFSApp
Target
Enables a component to be used in Field Service Mobile App Builder.
Configures the component for Field Service Mobile App Builder and defines component properties. The targetConfigs
tag contains at least one targetConfig
tag.
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="lightning__ECSFSApp"> or <targetConfig targets="lightning__ECSFSApp,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. You can also include one or more event
tags.
Specifies a public property of a component that can be set in Field Service Mobile 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. Valid values are:
| 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 Field Service Mobile App Builder. | |
label | String | Displays as a label for the attribute in Field Service Mobile App Builder. | |
placeholder | String | Input placeholder text for the attribute when it displays in Field Service Mobile 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 . | |
max | Integer | The maximum allowed value for an attribute of type Integer . | |
maxLength | Integer | The maximum number of characters allowed for an attribute of type String . | |
min | Integer | The minimum allowed value for an attribute of type Integer . | |
minLength | Integer | The minimum number of characters allowed for an attribute of type String . | |
required | Boolean | Specifies whether the attribute is required. The default value is false . |
To expose a component property in Field Service Mobile App Builder, define the property in the component’s JavaScript class using the @api
decorator.
See Also
- Salesforce Help: Customize Tabs with the Field Service Mobile App Builder
- XML Configuration File Elements