Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@conform-to/zod
Advanced tools
Readme
This tries to infer constraint of each field based on the zod schema. This is useful for:
:required
import { useForm } from '@conform-to/react';
import { getFieldsetConstraint } from '@conform-to/zod';
import { z } from 'zod';
const schema = z.object({
email: z.string({ required_error: 'Email is required' }),
password: z.string({ required_error: 'Password is required' }),
});
function Example() {
const [form, { email, password }] = useForm({
constraint: getFieldsetConstraint(schema),
});
// ...
}
It parses the formData and returns a submission result with the validation error. If no error is found, the parsed data will also be populated as submission.value
.
import { useForm } from '@conform-to/react';
import { parse } from '@conform-to/zod';
import { z } from 'zod';
const schema = z.object({
email: z.string({ required_error: 'Email is required' }),
password: z.string({ required_error: 'Password is required' }),
});
function ExampleForm() {
const [form, { email, password }] = useForm({
onValidate({ formData }) {
return parse(formData, {
schema,
});
},
});
// ...
}
Or when parsing the formData on server side (e.g. Remix):
import { useForm } from '@conform-to/react';
import { parse } from '@conform-to/zod';
import { z } from 'zod';
const schema = z.object({
// Define the schema with zod
});
export async function action({ request }) {
const formData = await request.formData();
const submission = await parse(formData, {
// If you need extra validation on server side
schema: schema.refine(/* ... */),
// If the schema definition includes async validation
async: true,
});
if (!submission.value || submission.intent !== 'submit') {
return submission;
}
// ...
}
A helper function to define a custom constraint on a superRefine check. This is mainly used to setup async validation.
import { refine } from '@conform-to/zod';
function createSchema(
intent: string,
constraints: {
// The validation will only be implemented on server side
isEmailUnique?: (email) => Promise<boolean>;
} = {},
) {
return z.object({
email: z
.string({ required_error: 'Email is required' })
.email('Email is invalid')
// Pipe the schema so it runs only if the username is valid
.pipe(
z.string().superRefine((email, ctx) =>
refine(ctx, {
// It fallbacks to server validation when it returns an undefined value
validate: () => constraints.isEmailUnique?.(email),
// This makes it validate only when the user is submitting the form
// or updating the email
when: intent === 'submit' || intent === 'validate/email',
message: 'Email is already used',
}),
),
),
// ...
});
}
FAQs
Conform helpers for integrating with Zod
The npm package @conform-to/zod receives a total of 33,803 weekly downloads. As such, @conform-to/zod popularity was classified as popular.
We found that @conform-to/zod demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.