jc-entity-field
The schema defines the following properties:
Property | Type | Required | Description |
type | component.entity-field | true | |
instanceId | InstanceId | Expression | false | |
when | Expression | boolean | false | |
options | Entity Field Options | true | |
Properties of the options object:
Property | Type | Required | Description |
label | string | Expression | TextWithFormat | TextLocale | true | Label of field |
value | string | Expression | TextWithFormat | TextLocale | boolean | true | Value of field |
isMultiline | boolean | string | false | If true, the field can span multiple lines. The default value is false. |
contentType | EntityFieldType | false | Type of visual and behaviour of entity field |
href | string | Expression | TextWithFormat | TextLocale | false | Eg. Full length url when contentType is link. |
rightIcon | icon-name | string | false | Optional custom right icon |
isRightIconHidden | boolean | string | false | If true, right icon will be hidden |
isHidden | boolean | string | false | If true it will be hidden to user. This is useful |
isTrackingTransparencyRequired | boolean | string | false | If TRUE tracking transparency permission modal will be shown before opening the url. Default TRUE |
style | object | false | |
Label of field
Value of field
The object must be any of the following types:
If true, the field can span multiple lines. The default value is false.
The object must be any of the following types:
Default: false
Type of visual and behaviour of entity field
Eg. Full length url when contentType is link.
rightIcon (icon-name | string)
Optional custom right icon
The object must be any of the following types:
If true, right icon will be hidden
The object must be any of the following types:
If true it will be hidden to user. This is useful
The object must be any of the following types:
If TRUE tracking transparency permission modal will be shown before opening the url. Default TRUE
The object must be any of the following types:
Properties of the style object:
Property | Type | Required | Description |
isPrimary | boolean | string | false | Will overwrite component color with "isPrimary" theme |
isNegative | boolean | string | false | Will overwrite component color with "isError" theme |
isPositive | boolean | string | false | Will overwrite component color with "isPositive" theme |
isWarning | boolean | string | false | Will overwrite component color with "isWarning" theme |
Will overwrite component color with "isPrimary" theme
The object must be any of the following types:
Default: false
Will overwrite component color with "isError" theme
The object must be any of the following types:
Default: false
Will overwrite component color with "isPositive" theme
The object must be any of the following types:
Default: false
Will overwrite component color with "isWarning" theme
The object must be any of the following types:
Default: false
The schema defines the following additional types:
This element must be one of the following enum values:
- default
- phone
- email
- date
- time
- link
- copy
- signature
- checkbox
This element must be one of the following enum values:
- light
- multicolor
- solid
- brand
- flag