Optional onCalled when the InputValueHost's InputValue property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual InputValueHosts. Here, it aggregates all InputValueHost notifications.
Optional onCalled when the state of validation has changed on a ValidatableValueHost. That includes validate(), clearValidation(), setBusinessLogicErrors(), clearBusinessLogicErrors() and a few edge cases. Supplies the current ValidationState to the callback. Examples: Use to notify the validation related aspects of the component to refresh, such as showing error messages and changing style sheets. Use to change the disabled state of the submit button based on validity. See also onValidationStateChanged for a similar callback from the ValidationManager.
(An override) Services that are needed by ValidationManager
Optional savedThe InstanceState for the ValidationManager itself. Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValidationManager with the correct state. If you don't have any state, leave this null or undefined and ValidationManager will initialize its state.
Optional savedThe state for each ValueHost. The array may not have the same states for all the ValueHostConfigs you are supplying. It will create defaults for those missing and discard those no longer in use.
Its up to you to retain stateful information so that the service works statelessly. It will supply you with the changes to states through the OnValueHostInstanceStateChanged property. Whatever it gives you, you supply here to rehydrate the ValidationManager with the correct state. You can also supply the state of an individual ValueHost when using the addValueHost or addOrUpdateValueHost methods. If you don't have any state, leave this null or undefined and ValidationManager will initialize its state.
Optional onCalled when the state of validation has changed on a ValidatableValueHost. That includes validate(), clearValidation(), setBusinessLogicErrors(), clearBusinessLogicErrors() and a few edge cases. Supplies the current ValidationState to the callback. Examples: Use to notify the Validation Summary widget(s) to refresh. Use to change the disabled state of the submit button based on validity. See also onValueHostValidationStateChanged for a similar callback from individual ValueHosts.
Optional notifyProvides a debounce delay for onValidationStateChanged notifications. The delay is in milliseconds.
onValidationStateChanged runs after each valueHost.validate() call, even though onValueHostValidationStateChanged also runs. Some features need to know about the general change to the validation state, not just on the individual field. So they expect onValidationStateChanged to run after valueHost.validate() runs. A call by ValidationManager.validate() will validate a list of valueHosts, and all of them will try to invoke onValidationStateChanged. That's too many in a short period. This debounces them so ValidationManager.validated() generally has one call.
Leave undefined to use the default of defaultNotifyValidationStateChangedDelay. Set to 0 to disable the debounce.
Optional onCalled when any ValueHost had its ValueHostInstanceState changed. React example: React component useState feature retains this value and needs to know when to call the setValueHostInstanceState() with the stateToRetain. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Optional onCalled when the ValueHost's Value property has changed. If setup, you can prevent it from being fired with the options parameter of setValue() to avoid round trips where you already know the details. You can setup the same callback on individual ValueHosts. Here, it aggregates all ValueHost notifications.
Initial list of ValueHostConfigs. Here's where all of the action is! Each ValueHostConfig describes one ValueHost (which is info about one value in your app), plus its validation rules. If rules need to be changed later, either create a new instance of ValueHostsManager or use its addValueHost, addOrUpdateValueHost, discardValueHost methods.
Optional onCalled when the ValueHostsManager's InstanceState has changed. React example: React component useState feature retains this value and needs to know when to call the setState function with the stateToRetain
Optional onUse this when caching the configuration for a later creation of ValueHostsManager.
Called when the configuration of ValueHosts has been changed, usually through the ValueHostsManagerConfigModifier.apply, or these members of ValueHostsManager: addValueHost, addOrUpdateValueHost, addOrMergeValueHost, discardValueHost. The supplied object is a clone so modifications will not impact the ValueHostsManager.
Note that where a ValueHostConfig has a property that references a function, you will have to retain that reference in some way to reuse it. In particular, ValidatorConfig.conditionCreator.
Generated using TypeDoc v0.25.12
Provides the configuration for the ValidationManager constructor