Core: Trigger watchForError callbacks from setError#406
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Design: Trigger watchForError callbacks from setError
Problem
ENGrid.watchForError()observes.en__errorListfor added children, butENGrid.setError()adds.en__field__errordirectly to a field wrapper. As a result, callbacks registered throughwatchForErrordo not run whensetErrordisplays a field-level error.Goal
Make
setErrortrigger all callbacks registered withwatchForError, without breaking backward compatibility.Constraints
setError(element, errorMessage)andwatchForError(callback).watchForError(callback key derived fromcallback.toString()).ENGrid.enableSubmitandiFrame.sendIframeHeight; both are idempotent.Approach: Shared Callback Registry
Add a module-level
Map<string, Function>topackages/scripts/src/engrid.ts.watchForErrorregisters the callback in the map and also attaches the existing.en__errorListMutationObserver.setErroriterates the map and invokes each registered callback after injecting the field-level error.Changes
packages/scripts/src/engrid.tsconst errorCallbacks = new Map<string, Function>();at module scope.callbackTypederivation into a private helper so bothwatchForErrorandsetErrorcan use it.watchForError, register the callback in the map before attaching the observer.setError, after adding/updating.en__field__error, invoke every callback in the map.Backward Compatibility
setError. This is the intended behavior change.