jc-signature-field
The schema defines the following properties:
Property | Type | Required | Description |
type | component.signature-field | true | |
instanceId | string | true | |
when | Expression | boolean | false | |
options | Signature Field Options | true | |
Properties of the options object:
Property | Type | Required | Description |
label | string | Expression | TextWithFormat | TextLocale | true | Label is displayed as placeholder when no value. |
icon | icon-name | string | false | Trailing icon. |
helperText | string | Expression | TextWithFormat | TextLocale | false | Helper text is displayed only when there is no errorText. |
errorText | string | Expression | TextWithFormat | TextLocale | false | Text displayed when field's value is not valid. When not empty it displays isNegative style as well. |
style | Date Picker Style | false | More of them can be true. It will be evaluated based on priority. |
isAutoFocused | boolean | false | If true it will get focus immediately after it is displayed to user. |
isRequired | boolean | string | false | True when the field is required. Useful when you use it in form submission. |
isOptionalLabelHidden | boolean | string | false | If the field is optional you can turn off the "(optional)" label if you want. |
isIgnored | boolean | string | false | When true, the field will be ignored when submitting the form. |
isHidden | boolean | string | false | If true it will be hidden to user. |
initialValue | string | string | false | Initial value of the relevant field. You can use this to preset value, so user doesn't need to add anything and use this "default". |
value | string | string | false | The value to show for the field. Text field is a controlled component, which means the internal value will be forced to match this value prop if provided. In most cases, you don't need to use this. |
onChange | false | Action Keg component that will be triggered when value is changed | |
nextProperty | string | false | Name of the property you want to focus next in form when you use "submit" on virtual keyboard. |
color | object[] | false | Changing color of field based on conditions. First evaluated to true will be used. |
Label is displayed as placeholder when no value.
icon (icon-name | string)
Trailing icon.
The object must be any of the following types:
Helper text is displayed only when there is no errorText.
Text displayed when field's value is not valid. When not empty it displays isNegative style as well.
More of them can be true. It will be evaluated based on priority.
Properties of the style object:
Property | Type | Required | Description |
isDisabled | boolean | string | false | Change style to disabled. User can't do anything with field when disabled. |
isBusy | boolean | string | false | Displays spinner on right side of text field. It removes icon if any. |
isPositive | boolean | string | false | Displays success icon on right side of text field. |
flex | number | false | Flex property if rendered inside row |
Change style to disabled. User can't do anything with field when disabled.
The object must be any of the following types:
Displays spinner on right side of text field. It removes icon if any.
The object must be any of the following types:
Displays success icon on right side of text field.
The object must be any of the following types:
True when the field is required. Useful when you use it in form submission.
The object must be any of the following types:
If the field is optional you can turn off the "(optional)" label if you want.
The object must be any of the following types:
When true, the field will be ignored when submitting the form.
The object must be any of the following types:
If true it will be hidden to user.
The object must be any of the following types:
Initial value of the relevant field. You can use this to preset value, so user doesn't need to add anything and use this "default".
The object must be any of the following types:
The value to show for the field. Text field is a controlled component, which means the internal value will be forced to match this value prop if provided. In most cases, you don't need to use this.
The object must be any of the following types:
Action Keg component that will be triggered when value is changed
Changing color of field based on conditions. First evaluated to true will be used.
The object is an array with all elements of the type object.
The array object has the following properties:
