Get if this context is valid. Notice this does not verify the validity.
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.
When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
Optionaloptions: boolean | AddEventListenerOptionsAdd a path translator to this validation context.
Add a validator to this context. This validator will have to be valid for the context to be valid. If the context is in validation mode, the validator will be validated immediately.
{ UmbValidator } - The validator to add to this context.
Continuously synchronize the messages from this context to the parent context.
Callback method called when context is resolved.
Reference to the created Context Consumer Controller instance
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Focus the first invalid element that this context can find.
Optionaloptions: UmbClassGetContextOptionsA Promise with the reference to the Context Api Instance
Inherit from a parent validation context, notice you should only use this method if you have the validation context at hand. Otherwise use setDataPath which uses Context-API to retrieve the right parent.
The parent validation context to inherit from.
The data path to bind this validation context to.
An Observable to observe from.
Optionalcallback: ObserverCallback<SpecificT>Callback method called when data is changed.
OptionalcontrollerAlias: null | UmbControllerAliasDefine an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Reference to the created Observer Controller instance.
Provides the validation context to the current host, if not already provided to a different host.
instance {UmbValidationController} - Returns it self.
Provide this validation context to a specific controller host. This can be used to Host a validation context in a Workspace, but provide it on a certain scope, like a specific Workspace View.
The controller host to provide this validation context to.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
Removes the event listener in target's event listener list with the same type, callback, and options.
Optionaloptions: boolean | EventListenerOptionsRemove a path translator from this validation context.
The translator to remove.
Remove a validator from this context.
{UmbValidator} - The validator to remove from this context.
Perform a one time transfer of the messages from this context to the parent context.
Reset the validation state of this context.
Define a specific data path for this validation context. This will turn this validation context into a sub-context of the parent validation context. And thereby make this context inherit the messages from the parent validation context.
The data path to bind this validation context to.
report() to propagate changes to the parent context.autoReport() to continuously synchronize changes to the parent context.messages and data will be scoped accordingly to the given data path.
const validationContext = new UmbValidationContext(this);
validationContext.setDataPath("$.values[?(@.alias == 'my-property')].value");
A message with the path: '$.values[?(@.alias == 'my-property')].value.innerProperty', will for above example become '$.innerProperty' for the local Validation Context.
Validate this context, all the validators of this context will be validated. Notice its a recursive check meaning sub validation contexts also validates their validators.
succeed {Promise
Validation Context is the core of Validation. It hosts Validators that has to validate for the context to be valid. It can also be used as a Validator as part of a parent Validation Context.