forms/src/types.ts
Properties |
|
disableWhen |
disableWhen:
|
Type : string |
|
Optional |
Allows for providing a single presentation style or predicate function that determines whether or not the control is disabled or not. The control will always be disabled when Field.readonly is true, in which case this option is not considered. |
ifUnknown |
ifUnknown:
|
Type : any
|
Optional |
Specifies a value that is to be set when the Blueriq Runtime currently reports the field as having an unknown value. Useful for e.g. checkboxes that should be assigned a value of false upon being shown on a page. |
syncOn |
syncOn:
|
Type : "update" | "blur"
|
Optional |
Specifies the synchronization frequency of control value changes to the Blueriq Field.value. This setting affects the moment when the FieldValueChangedAction is dispatched, which in turn causes field refreshes to occur. When you specify 'update', the frequency is dependent on the update frequency as specified using the updateOn property. The default is to synchronize values from Angular's FormControl to Blueriq's Field on 'blur', however this event may not be triggered for all types of input, e.g. checkboxes, in which case this property should be set to 'update'. |
transformer |
transformer:
|
Type : Type<ValueTransformer> | ValueTransformer
|
Optional |
Specifies a transformer token or instance to be used during the synchronization of values from Blueriq fields to and from Angular's FormControl. If a Type is given, it must be provided as Angular service from an Angular module or parent component. Alternatively, a ValueTransformer instance itself may be given, which could be the component itself if it were to implement the ValueTransformer interface. |
updateOn |
updateOn:
|
Type : "change" | "blur"
|
Optional |
Specifies the update frequency of view updates to the form control instance, corresponding with Angular's equally named form control option. This affects the frequency of recomputing validation status, which is on each change by default. The 'submit' option is not supported given the dynamic nature of forms with Blueriq. To influence the moment when Blueriq field refreshes are triggered, use the syncOn property instead. |
useRejectedValue |
useRejectedValue:
|
Type : boolean
|
Optional |
It may happen that user input is not accepted by the Runtime, for example a date field cannot be interpreted as
a valid date. In that case, the field value cannot be updated and this would typically result in the field
reverting to its original value. If this flag is enabled, however, the rejected value is restored such that the
form control retains the user's invalid value. Defaults to |