Skip to content

README: Add guidance on passing context to yupResolver (useForm context) #835

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.

Sign up for GitHub

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

Open
eotkd4791 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README: Add guidance on passing context to yupResolver (useForm context) #835

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25adc7c
docs: clarify yupResolver context usage in README
eotkd4791 Jan 25, 2026
73e07e9
fix: ambigious expression
eotkd4791 Jan 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,19 @@ Dead simple Object schema validation.

[![npm](https://img.shields.io/bundlephobia/minzip/yup?style=for-the-badge)](https://bundlephobia.com/result?p=yup)

> ⚠️ Pass context via `useForm({ context })`, not via `yupResolver`'s `schemaOptions`. Using React state/atoms via `schemaOptions.context` can result in `undefined` values.

```typescript jsx
// Correct
useForm({
resolver: yupResolver(schema),
context: { foo: true },
});

// Avoid - context will be stale/undefined
yupResolver(schema, { context: { foo: true } });
```

```typescript jsx
import { useForm } from 'react-hook-form';
import { yupResolver } from '@hookform/resolvers/yup';
Expand Down