-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: custom values and errors #3305
Merged
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## main #3305 +/- ##
==========================================
+ Coverage 96.66% 96.69% +0.02%
==========================================
Files 65 65
Lines 1531 1574 +43
Branches 371 380 +9
==========================================
+ Hits 1480 1522 +42
- Misses 50 51 +1
Partials 1 1
Continue to review full report at Codecov.
|
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.
What
by default, the validation schema ignores errors for non-existent fields, this can be often mistaken for bugs and may not be very intuitive for new users.
This was by design initially to support a use-case of "multi-step" forms, where a schema may partially exist.
However, I have thought about this more and I think this behavior should be customizable.
How
We can introduce a concept of
virtual
field, basically, the form API would allow you to create custom errors or values.These fields will be also created if they exist in the schema but didn't have an associated field rendered. This could be a breaking change for some, but I think going forward the schema should be treated as a strict source of truth for the fields that should be rendered.
The use case that would be broken by this behavior is "multi-step" forms, since before this PR a valid partial is considered a valid submission which is problematic more often than not.
For "multi-step" forms we can let it be handled userland, which means you will have to utilize either computed schemas or craft conditional ones to validate each step as its own schema. The official examples will be updated to handle this.
closes #3062