Feature: Pass Yup context to validationSchema using new prop validationSchemaContext in <Formik>

[john-raymon]

Closes #3450

• This PR creates a new prop in the <Formik> component called validationSchemaContext for Yup context, which is then passed to the validationSchema here (see below):

formik/packages/formik/src/Formik.tsx

Lines 230 to 241 in ccdcb39

	const runValidationSchema = React.useCallback(
	(values: Values, field?: string): Promise<FormikErrors<Values>> => {
	const validationSchema = props.validationSchema;
	const schema = isFunction(validationSchema)
	? validationSchema(field)
	: validationSchema;
	const promise =
	field && schema.validateAt
	? schema.validateAt(field, values, {
	context: props.validationSchemaContext
	})
	: validateYupSchema(values, schema, false, props.validationSchemaContext);

Note the validateYupSchema function already had an optional context argument, and it also already had a third argument called sync which is set to default to false in the function definition. , no changes were made below. (see below)

formik/packages/formik/src/Formik.tsx

Lines 1079 to 1091 in ccdcb39

	export function validateYupSchema<T extends FormikValues>(
	values: T,
	schema: any,
	sync: boolean = false,
	context?: any
	): Promise<Partial<T>> {
	const normalizedValues: FormikValues = prepareDataForValidation(values);
	return schema[sync ? 'validateSync' : 'validate'](normalizedValues, {
	abortEarly: false,
	context: context || normalizedValues,
	});
	}

• Wrote tests in both Formik.test.tsx and in yupHelpers.test.ts.

• Added types for the new prop.

• Updated the docs to include the new prop in the <Formik> api page

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7bf3d7e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
formik-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 1, 2024 8:25pm

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

[mikegreiling]

What can be done to move this PR forward? I could really use this feature and I'd be happy to contribute, but it looks like this has gone 8 months with no feedback from code owners :(

[Cbridger-mywellabee]

I just ripped out RHF and replaced it with Formik because RHF doesn't support errors being raised on fields that weren't touched (although it supported contexts!), only to find out Formik doesn't currently support Yup Contexts 😅, I would love it if this PR could gain some momentum!

[yogiduzit]

+1, would appreciate this PR's prioritization.

[rgallison]

Chiming in as this is an issue my team faces regularly

[higgsboz-beam]

+1 on this being a useful feature to me and my team

[john-raymon]

@jaredpalmer @quantizor