import React from 'react'; import { act, fireEvent, render, renderHook, screen, waitFor, } from '@testing-library/react'; import { VALIDATION_MODE } from '../../constants'; import type { Control, FieldPath } from '../../types'; import { useController } from '../../useController'; import { useForm } from '../../useForm'; import { FormProvider } from '../../useFormContext'; import { useFormState } from '../../useFormState'; import noop from '../../utils/noop'; describe('trigger', () => { it('should remove all errors before set new errors when trigger entire form', async () => { const Component = () => { const [show, setShow] = React.useState(true); const { register, unregister, trigger, formState: { errors }, } = useForm<{ test: string; }>(); return (
{show && } {errors.test && error}
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'trigger' })); expect(await screen.findByText('error')).toBeVisible(); fireEvent.click(screen.getByRole('button', { name: 'toggle' })); fireEvent.click(screen.getByRole('button', { name: 'trigger' })); await waitFor(() => expect(screen.queryByText('error')).not.toBeInTheDocument(), ); }); it('should return empty errors when field is found and validation pass', async () => { const { result } = renderHook(() => useForm<{ test: string }>()); const { errors } = result.current.formState; result.current.register('test'); await act(async () => { await result.current.trigger('test'); }); await act(async () => { await expect(errors).toEqual({}); }); }); it('should update value when value is supplied', async () => { const { result } = renderHook(() => useForm<{ test: string }>()); const { errors } = result.current.formState; result.current.register('test', { required: true }); result.current.setValue('test', 'abc'); await act(async () => { await result.current.trigger('test'); }); expect(errors).toEqual({}); }); it('should trigger multiple fields validation', async () => { const { result } = renderHook(() => useForm<{ test: string; test1: string }>({ mode: VALIDATION_MODE.onChange, }), ); result.current.formState.errors; result.current.register('test', { required: 'required' }); result.current.register('test1', { required: 'required' }); await act(async () => { await result.current.trigger(['test', 'test1']); }); expect(result.current.formState.errors?.test?.message).toBe('required'); expect(result.current.formState.errors?.test1?.message).toBe('required'); }); describe('with schema', () => { it('should return the error with single field validation', async () => { const resolver = async (data: any) => { return { values: data, errors: { test: { type: 'test', }, }, }; }; const { result } = renderHook(() => useForm<{ test: string }>({ mode: VALIDATION_MODE.onChange, resolver, }), ); result.current.formState.errors; result.current.register('test', { required: true }); await act(async () => { await result.current.trigger('test'); }); expect(result.current.formState.errors).toEqual({ test: { type: 'test' }, }); }); it('should return the status of the requested field with single field validation', async () => { const resolver = async (data: any) => { return { values: data, errors: { test2: { type: 'test', }, }, }; }; const { result } = renderHook(() => useForm<{ test1: string; test2: string }>({ mode: VALIDATION_MODE.onChange, resolver, }), ); result.current.formState.errors; result.current.register('test1', { required: false }); result.current.register('test2', { required: true }); await act(async () => expect(await result.current.trigger('test2')).toBeFalsy(), ); expect(result.current.formState.errors).toEqual({ test2: { type: 'test', }, }); }); it('should not trigger any error when schema validation result not found', async () => { const { result } = renderHook(() => useForm<{ test: string; test1: string }>({ mode: VALIDATION_MODE.onChange, resolver: async () => { return { values: {}, errors: { test: { type: 'test', }, }, }; }, }), ); result.current.register('test', { required: true }); await act(async () => { await result.current.trigger('test1'); }); expect(result.current.formState.errors).toEqual({}); }); it('should support array of fields for schema validation', async () => { const resolver = async (data: any) => { return { values: data, errors: { test1: { type: 'test1', }, test: { type: 'test', }, }, }; }; const { result } = renderHook(() => useForm<{ test: string; test1: string }>({ mode: VALIDATION_MODE.onChange, resolver, }), ); result.current.formState.errors; result.current.register('test', { required: true }); await act(async () => { await result.current.trigger(['test', 'test1']); }); expect(result.current.formState.errors).toEqual({ test1: { type: 'test1', }, test: { type: 'test', }, }); }); it('should return the status of the requested fields with array of fields for validation', async () => { const { result } = renderHook(() => useForm<{ test1: string; test2: string; test3: string }>({ mode: VALIDATION_MODE.onChange, resolver: async () => { return { values: {}, errors: { test3: { type: 'test', }, }, }; }, }), ); const { errors } = result.current.formState; result.current.register('test1', { required: false }); result.current.register('test2', { required: false }); result.current.register('test3', { required: true }); await act(async () => { await result.current.trigger(['test1', 'test2']); }); await act(async () => { expect(errors).toEqual({}); }); await act(async () => { await result.current.trigger(['test3']); }); await act(async () => { expect(result.current.formState.errors).toEqual({ test3: { type: 'test', }, }); }); }); it('should validate all fields when pass with undefined', async () => { const resolver = async (data: any) => { return { values: data, errors: { test1: { type: 'test1', }, test: { type: 'test', }, }, }; }; const { result } = renderHook(() => useForm<{ test1: string; test: string }>({ mode: VALIDATION_MODE.onChange, resolver, }), ); result.current.formState.errors; result.current.register('test', { required: true }); result.current.register('test1', { required: true }); await act(async () => { await result.current.trigger(); }); expect(result.current.formState.errors).toEqual({ test1: { type: 'test1', }, test: { type: 'test', }, }); }); it('should update isValid with validation result at form level', async () => { const App = () => { const { register, formState: { isValid }, trigger, } = useForm<{ test: string; test1: string }>({ defaultValues: { test: '', }, resolver: async (data) => { if (data.test && data.test1) { return { errors: {}, values: { test: '1', test1: '2', }, }; } else { return { errors: { test: { message: 'test', type: 'test', }, }, values: {}, }; } }, }); return (
{isValid ? 'yes' : 'no'}
); }; render(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: 'test', }, }); fireEvent.click(screen.getByRole('button', { name: 'trigger1' })); expect(await screen.findByText('no')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: 'test', }, }); fireEvent.click(screen.getByRole('button', { name: 'trigger2' })); expect(await screen.findByText('yes')).toBeVisible(); }); it('should update isValid for the entire useForm scope', async () => { const InputA = () => { const { isValid } = useFormState({ name: 'name' }); return

{isValid ? 'test: valid' : 'test: invalid'}

; }; const InputB = () => { const { isValid } = useFormState({ name: 'email' }); return

{isValid ? 'test1: valid' : 'test1: invalid'}

; }; function App() { const methods = useForm({ resolver: async (data) => { if (data.test && data.test1) { return { errors: {}, values: { test: '1', test1: '2', }, }; } else { return { errors: { test: { message: 'test', type: 'test', }, }, values: {}, }; } }, mode: 'onChange', }); return (
methods.setValue('test', e.target.value, { shouldValidate: true, }) } /> methods.setValue('test1', e.target.value, { shouldValidate: true, }) } />
); } render(); expect(await screen.findByText('test: invalid')).toBeVisible(); expect(screen.getByText('test1: invalid')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: 'test' }, }); expect(await screen.findByText('test: invalid')).toBeVisible(); expect(screen.getByText('test1: invalid')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: 'test' }, }); expect(await screen.findByText('test: valid')).toBeVisible(); expect(screen.getByText('test1: valid')).toBeVisible(); }); }); it('should return the status of the requested fields with array of fields for validation', async () => { const resolver = async (data: any) => { return { values: data, errors: { test3: 'test3' }, }; }; const { result } = renderHook(() => useForm<{ test1: string; test2: string; test3: string }>({ mode: VALIDATION_MODE.onChange, resolver, }), ); result.current.register('test1', { required: false }); result.current.register('test2', { required: false }); result.current.register('test3', { required: true }); await act(async () => expect(await result.current.trigger(['test1', 'test2'])).toBeTruthy(), ); await act(async () => expect(await result.current.trigger(['test3', 'test2'])).toBeFalsy(), ); await act(async () => expect(await result.current.trigger(['test3'])).toBeFalsy(), ); await act(async () => expect(await result.current.trigger(['test1'])).toBeTruthy(), ); await act(async () => expect(await result.current.trigger()).toBeFalsy()); }); it('should return true when field is found and validation pass', async () => { const App = () => { const { register, trigger, formState: { isValid }, } = useForm(); React.useEffect(() => { register('test'); }, [register]); return (

{isValid ? 'yes' : 'no'}

); }; render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('yes')).toBeVisible(); }); it('should remove all errors before set new errors when trigger entire form', async () => { const Component = () => { const [show, setShow] = React.useState(true); const { register, trigger, formState: { errors }, } = useForm<{ test: string; }>({ shouldUnregister: true, }); return (
{show && } {errors.test && error}
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'trigger' })); expect(await screen.findByText('error')).toBeVisible(); fireEvent.click(screen.getByRole('button', { name: 'toggle' })); fireEvent.click(screen.getByRole('button', { name: 'trigger' })); await waitFor(() => expect(screen.queryByText('error')).not.toBeInTheDocument(), ); }); it('should focus on errored input with build in validation', async () => { const Component = () => { const { register, trigger } = useForm<{ test: string; }>(); return ( <> ); }; render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => { expect(document.activeElement).toEqual( screen.getByPlaceholderText('test'), ); }); }); it('should focus on errored input with schema validation', async () => { const Component = () => { const { register, trigger } = useForm<{ test: string; }>({ resolver: () => ({ values: {}, errors: { test: { type: 'test', }, }, }), }); return ( <> ); }; render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => { expect(document.activeElement).toEqual( screen.getByPlaceholderText('test'), ); }); }); it('should focus on first errored input', async () => { const Component = () => { const { register, trigger } = useForm<{ test: string; test2: string; }>(); return ( <> ); }; render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => { expect(document.activeElement).toEqual( screen.getByPlaceholderText('test'), ); }); }); it('should return isValid for the entire form', async () => { const App = () => { const [isValid, setIsValid] = React.useState(true); const { register, trigger, formState } = useForm(); formState.isValid; return (

{isValid ? 'true' : 'false'}

); }; render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('false')).toBeVisible(); fireEvent.change(screen.getByPlaceholderText('firstName'), { target: { value: '1234', }, }); fireEvent.change(screen.getByPlaceholderText('lastName'), { target: { value: '1234', }, }); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('true')).toBeVisible(); }); it('should return correct valid state when trigger the entire form with build in validation', async () => { let isValid; function App() { const { register, trigger } = useForm(); const onTrigger = async () => { isValid = await trigger(); }; return (
); } render(); fireEvent.click(screen.getByRole('button')); expect(isValid).toBeFalsy(); }); it('should be able to trigger an object of fields', async () => { let isValid; function App() { const { register, trigger, formState: { errors }, } = useForm({ defaultValues: { test: { firstName: '', lastName: '', }, }, }); const onTrigger = async () => { isValid = await trigger('test'); }; return (
{errors?.test?.firstName &&

firstName

} {errors?.test?.lastName &&

lastName

}
); } render(); fireEvent.click(screen.getByRole('button')); expect(isValid).toBeFalsy(); expect(await screen.findByText('firstName')).toBeVisible(); expect(screen.getByText('lastName')).toBeVisible(); }); it('should only trigger render on targeted input', async () => { type FormValue = { x: string; y: string; }; function Input({ name, control, }: { name: FieldPath; control: Control; }) { const renderCount = React.useRef(0); renderCount.current += 1; const { fieldState: { error }, } = useController({ name, control, rules: { required: true, }, }); error; return

{renderCount.current}

; } function App() { const { handleSubmit, control, trigger } = useForm(); const onSubmit = noop; return (
); } render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('2')).toBeVisible(); expect(screen.getByText('3')).toBeVisible(); }); it('should skip additional validation when input validation already failed', async () => { let count = 0; const App = () => { const { register, trigger, formState: { isValid }, } = useForm({ mode: 'onChange', }); const validate = () => { count++; return false; }; return (

{isValid ? 'valid' : 'invalid'}

); }; render(); expect(await screen.findByText('invalid')).toBeVisible(); fireEvent.click(screen.getByRole('button')); expect(count).toEqual(2); }); });