diff --git a/packages/ui/docs/FORM-COMPONENTS.md b/packages/ui/docs/FORM-COMPONENTS.md index 6174152..0b47481 100644 --- a/packages/ui/docs/FORM-COMPONENTS.md +++ b/packages/ui/docs/FORM-COMPONENTS.md @@ -258,10 +258,10 @@ To prevent over-engineering and package fatigue, we house the validation layer d ### Writing a Centralized Validator ```tsx -// packages/ui/src/validators/base.validator.ts +// packages/ui/src/validators/sample.validator.ts import { z } from 'zod'; -export const baseValidator = z.object({ +export const sampleValidator = z.object({ email: z.string().email({ message: JSON.stringify({ key: 'validation:invalid_email' }), }), @@ -273,7 +273,7 @@ export const baseValidator = z.object({ }), }); -export type BaseValidatorType = z.infer; +export type SampleValidatorType = z.infer; ``` ### Applying the Validator @@ -284,15 +284,15 @@ When consuming these validators, use the `zodResolver` exported from `@repo/ui/f import { useForm, type SubmitHandler } from 'react-hook-form'; import { zodResolver } from '@hookform/resolvers/zod'; import { FieldTextInput } from '@repo/ui/form'; -import { baseValidator, type BaseValidatorType } from '@repo/ui/validators'; +import { sampleValidator, type SampleValidatorType } from '@repo/ui/validators'; function ExampleForm() { - const { control, handleSubmit } = useForm({ - resolver: zodResolver(baseValidator), + const { control, handleSubmit } = useForm({ + resolver: zodResolver(sampleValidator), defaultValues: { email: '', name: '' }, }); - const onSubmit: SubmitHandler = (data) => console.log(data); + const onSubmit: SubmitHandler = (data) => console.log(data); return (
diff --git a/packages/ui/src/validators/index.ts b/packages/ui/src/validators/index.ts index 3ced934..e0280a7 100644 --- a/packages/ui/src/validators/index.ts +++ b/packages/ui/src/validators/index.ts @@ -1 +1 @@ -export * from './base.validator'; +export * from './sample.validator'; diff --git a/packages/ui/src/validators/base.validator.ts b/packages/ui/src/validators/sample.validator.ts similarity index 71% rename from packages/ui/src/validators/base.validator.ts rename to packages/ui/src/validators/sample.validator.ts index 478aa52..7db625b 100644 --- a/packages/ui/src/validators/base.validator.ts +++ b/packages/ui/src/validators/sample.validator.ts @@ -1,6 +1,6 @@ import { z } from 'zod'; -export const baseValidator = z.object({ +export const sampleValidator = z.object({ email: z.string().email({ message: JSON.stringify({ key: 'validation:invalid_email' }), }), @@ -12,4 +12,4 @@ export const baseValidator = z.object({ }), }); -export type BaseValidatorType = z.infer; +export type SampleValidatorType = z.infer;