README: Add guidance on passing context to yupResolver (useForm context)#835
Open
eotkd4791 wants to merge 2 commits intoreact-hook-form:masterfrom
Open
README: Add guidance on passing context to yupResolver (useForm context)#835eotkd4791 wants to merge 2 commits intoreact-hook-form:masterfrom
yupResolver (useForm context)#835eotkd4791 wants to merge 2 commits intoreact-hook-form:masterfrom
Conversation
c5f8d15 to
25adc7c
Compare
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.
Reason for change
Yup typically uses the
schema.validate(values, { context })pattern, which naturally leads users to tryyupResolver(schema, { context }).However, yupResolver in
@hookform/resolversdoes not recommend using schemaOptions.context (there is a dev warning in the code), and this is not clearly documented in the README. This can increase debugging cost for users.What’s changed
useForm({ context }), and that this value is injected into Yup’s validation context at resolver execution time, with an example.Scope of impact
References
resolvers/yup/src/yup.ts
Line 100 in 2e9bc7c
react-hook-form/resolvers#834