import React from 'react'; import { act, fireEvent, render, renderHook, screen, waitFor, waitForElementToBeRemoved, } from '@testing-library/react'; import { VALIDATION_MODE } from '../../constants'; import { Controller } from '../../controller'; import type { UseFormRegister } from '../../types'; import { useForm } from '../../useForm'; import { FormProvider, useFormContext } from '../../useFormContext'; import isFunction from '../../utils/isFunction'; import isString from '../../utils/isString'; import noop from '../../utils/noop'; describe('register', () => { it('should support register passed to ref', async () => { const { result } = renderHook(() => useForm<{ test: string }>({ defaultValues: { test: 'testData', }, }), ); const { ref } = result.current.register('test'); isFunction(ref) && ref({ target: { value: 'testData', }, }); await act(async () => { await result.current.handleSubmit((data) => { expect(data).toEqual({ test: 'testData', }); })({ preventDefault: noop, persist: noop, } as React.SyntheticEvent); }); }); test.each([['text'], ['radio'], ['checkbox']])( 'should register field for %s type and remain its value after unmount', async (type) => { const Component = () => { const { register, watch, formState: { isDirty }, } = useForm<{ test: string; }>({ defaultValues: { test: 'test', }, }); const test = watch('test'); return (
{`${isDirty}`} {test}
); }; render(); const ref = screen.getByRole(type === 'text' ? 'textbox' : type); ref.remove(); expect(screen.getByRole('alert').textContent).toBe('false'); expect(screen.getByText('test')).toBeVisible(); }, ); test.each([['text'], ['radio'], ['checkbox']])( 'should not register the same %s input', async (type) => { const callback = jest.fn(); const Component = () => { const { register, handleSubmit } = useForm<{ test: string; }>(); return (
); }; render(); fireEvent.click(screen.getByRole('button', { name: /submit/ })); await waitFor(() => expect(callback).toHaveBeenCalledWith( { test: type === 'checkbox' ? false : type === 'radio' ? null : '', }, expect.any(Object), ), ); }, ); it('should determine checkbox group by type of reference value', async () => { const callback = jest.fn(); const Component = () => { const { register, handleSubmit } = useForm<{ test: string[]; }>({ defaultValues: { test: [], }, }); return (
); }; render(); fireEvent.click(screen.getByRole('checkbox')); fireEvent.click(screen.getByRole('button', { name: /submit/ })); await waitFor(() => expect(callback).toHaveBeenCalledWith( { test: ['A'], }, expect.any(Object), ), ); }); it('should re-render if errors occurred with resolver when formState.isValid is defined', async () => { const Component = () => { const { register, formState } = useForm<{ test: string }>({ resolver: async (data) => { return { values: data, errors: { test: { type: 'test', }, }, }; }, }); return (
{`${formState.isValid}`}
); }; render(); expect(screen.getByRole('alert').textContent).toBe('false'); }); it('should be set default value when item is remounted again', async () => { const { result, unmount } = renderHook(() => useForm<{ test: string }>()); result.current.register('test'); result.current.setValue('test', 'test'); unmount(); const ref = { type: 'text', name: 'test' }; result.current.register('test'); expect(ref).toEqual({ type: 'text', name: 'test' }); expect(result.current.getValues()).toEqual({ test: 'test' }); }); // issue: https://github.com/react-hook-form/react-hook-form/issues/2298 it('should reset isValid formState after reset with valid value in initial render', async () => { const Component = () => { const { register, reset, formState } = useForm<{ issue: string; test: string; }>({ mode: VALIDATION_MODE.onChange, }); React.useEffect(() => { setTimeout(() => { reset({ issue: 'test', test: 'test' }); }); }, [reset]); return (
); }; render(); await waitFor(() => { expect(screen.getByRole('button')).not.toBeDisabled(); }); }); it('should update isValid correctly with custom registered input', async () => { function Component() { const { register, setValue, formState: { isValid }, } = useForm({ defaultValues: { a: 'default', b: '' }, mode: 'onChange', }); React.useEffect(() => { register('a', { required: 'required', }); register('b', { required: 'required', }); }, [register]); return (
setValue('a', value, { shouldDirty: true, shouldValidate: true }) } /> setValue('b', value, { shouldDirty: true, shouldValidate: true }) } />
{String(isValid)}
); } render(); expect(screen.getByText('false')).toBeVisible(); fireEvent.input(screen.getByPlaceholderText('inputA'), { target: { value: 'test' }, }); expect(await screen.findByText('false')).toBeVisible(); fireEvent.input(screen.getByPlaceholderText('inputB'), { target: { value: 'test' }, }); expect(await screen.findByText('true')).toBeVisible(); }); it('should custom register with value and can be updated', async () => { const App = () => { const [inputValue, setInput] = React.useState(1); const [data, setData] = React.useState(''); const { handleSubmit, register, setValue } = useForm<{ test: string }>(); React.useEffect(() => { register('test', { value: 'bill', }); }, [register]); return (

{data}

); }; render(); fireEvent.click(screen.getByRole('button', { name: 'handleSubmit' })); fireEvent.click(screen.getByRole('button', { name: 'update' })); expect(await screen.findByText('bill')).toBeVisible(); fireEvent.click(screen.getByRole('button', { name: 'handleSubmit' })); expect(await screen.findByText('1234')).toBeVisible(); }); it('should not affect or check against defaultChecked inputs', async () => { type FormValues = Partial<{ radio: string; checkbox: string[]; }>; let output: FormValues; output = {}; function Component() { const { register, handleSubmit } = useForm(); return (
{ output = data; })} >
); }; render(); expect(watchedValue.at(-1)).toEqual({ test: 'bill' }); fireEvent.click(screen.getByRole('button')); // Let's check all values of renders with implicitly the number of render (for each value) expect(watchedValue).toEqual([ { test: 'bill', }, { test: 'bill', }, { test: 'bill', }, {}, ]); }); it('should keep defaultValue with shouldUnregister: true when input unmounts', () => { type FormValue = { test: string; }; const Component = () => { const { register } = useForm({ defaultValues: { test: 'bill', }, shouldUnregister: true, }); const [show, setShow] = React.useState(true); return ( <> {show && } ); }; render(); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( 'bill', ); fireEvent.click(screen.getByRole('button')); fireEvent.click(screen.getByRole('button')); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( 'bill', ); }); it('should skip register absent fields which are checkbox/radio inputs', async () => { let data: unknown; const App = () => { const { register, handleSubmit } = useForm({ defaultValues: { test: ['1', '2', '3'], nested: { test: {}, test1: [], }, }, }); return (
(data = d))}>
); }; render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(data).toEqual({ nested: { test: {}, test1: [], }, test: ['1', '2', '3'], }), ); fireEvent.click(screen.getAllByRole('checkbox')[0]); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(data).toEqual({ test: ['2', '3'], nested: { test: {}, test1: [], }, }), ); }); describe('register disabled', () => { it('should return undefined for disabled inputs', async () => { let output = {}; const defaultValues = { test: true, }; function App() { const { register, handleSubmit } = useForm({ defaultValues: defaultValues, }); return (
{ output = values; })} > {[ { value: 'test', label: 'test' }, { value: 'test1', label: 'test1' }, ].map((item) => ( ))}
); } render(); fireEvent.click(screen.getByRole('button')); expect(output).toEqual({ test: undefined, }); }); it('should still show all inputs which has disabled set to true', async () => { let outputData: object = {}; const watchedData: object[] = []; const Component = () => { const { register, handleSubmit, watch } = useForm<{ test?: string; test1?: string; test2?: string; test3?: string; test4: string; }>(); watchedData.push(watch()); return (
{ outputData = data; })} >
); }; render(); fireEvent.change(screen.getByTestId('input'), { target: { value: '1234' }, }); fireEvent.click(screen.getByRole('button')); expect(watchedData).toStrictEqual([ {}, { test: '', test1: false, test2: null, test3: '', test4: '', }, { test: '', test1: false, test2: null, test3: '', test4: '1234', }, ]); await waitFor(() => expect(outputData).toStrictEqual({ test: '', test1: false, test2: null, test3: '', test4: '1234', }), ); }); it('should validate value after toggling enabled/disabled on input', async () => { const defaultValue = 'Test'; const validate = jest.fn(); const submit = jest.fn(); const onSubmit = (values: unknown) => { submit(values); }; const App = () => { const [editable, setEditable] = React.useState(false); const { register, handleSubmit } = useForm(); return (
); }; render(); expect(validate).toBeCalledTimes(0); fireEvent.click(screen.getByText('Toggle Edit')); fireEvent.click(screen.getByText('Submit')); expect(validate).toBeCalledWith(defaultValue, { test: 'Test' }); await waitFor(() => expect(submit).toBeCalledWith({ test: defaultValue }), ); fireEvent.click(screen.getByText('Toggle Edit')); fireEvent.click(screen.getByText('Submit')); await waitFor(() => expect(submit).toBeCalledWith({ test: undefined })); }); it('should not throw errors with disabled input', async () => { const message = 'Must have at least one checked!'; function Checkbox() { const { register } = useFormContext(); return ( <>

Must select: { return value && value.length > 0 ? true : message; }, })} /> A

); } function App() { const formMethods = useForm({ mode: 'onSubmit', defaultValues: { test: '' }, }); const { handleSubmit, formState } = formMethods; return ( <>

{formState.errors.test?.message}

); } render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText(message)).toBeVisible(); fireEvent.click(screen.getByRole('checkbox')); fireEvent.click(screen.getByRole('button')); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(screen.queryByText(message)).not.toBeInTheDocument(), ); }); it('should affect a group of checked attribute with disabled attribute', () => { const App = () => { const { register } = useForm(); const options = [ { checked: false, disabled: false, value: 'test' }, { checked: true, disabled: true, value: 'test1' }, { checked: false, disabled: false, value: 'test2' }, ]; return ( <> {options.map((option, index) => { return (
); })} ); }; render(); expect( (screen.getByTestId('checkbox0') as HTMLInputElement).checked, ).toBeFalsy(); expect( (screen.getByTestId('checkbox1') as HTMLInputElement).checked, ).toBeTruthy(); expect( (screen.getByTestId('checkbox2') as HTMLInputElement).checked, ).toBeFalsy(); }); it('should affect a single checked attribute with disabled attribute', () => { const App = () => { const { register } = useForm<{ test: boolean; test1: boolean; test2: boolean; }>({ defaultValues: { test: true, test1: true, }, }); return (
); }; render(); expect( (screen.getByTestId('checkbox1') as HTMLInputElement).checked, ).toBeTruthy(); expect( (screen.getByTestId('checkbox2') as HTMLInputElement).checked, ).toBeTruthy(); expect( (screen.getByTestId('checkbox3') as HTMLInputElement).checked, ).toBeTruthy(); }); it('should work correctly with toggle disabled attribute and validation', async () => { type FormValues = { test: string; }; function Input({ disabled, register, }: { disabled: boolean; register: UseFormRegister; }) { const options = { disabled, validate: (value: string) => { return value && value.length > 0 ? true : 'Must have at least one checked!'; }, }; return ( ); } const App = () => { const [value, setValue] = React.useState({}); const [disabled, setDisabled] = React.useState(false); const { register, handleSubmit, formState: { errors }, } = useForm(); return (
{errors.test &&

error

}

{JSON.stringify(value)}

); }; render(); fireEvent.click(screen.getByRole('checkbox')); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect(await screen.findByText('{"test":"a"}')).toBeVisible(); fireEvent.click(screen.getByRole('button', { name: 'setDisabled' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect(await screen.findByText('{}')).toBeVisible(); fireEvent.click(screen.getByRole('button', { name: 'setDisabled' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); expect(await screen.findByText('{"test":"a"}')).toBeVisible(); }); }); describe('register valueAs', () => { it('should return number value with valueAsNumber', async () => { let output = {}; const Component = () => { const { register, handleSubmit } = useForm<{ test: number; test1: boolean; }>(); return (
(output = data))}> value === 'true', })} />
); }; render(); fireEvent.input(screen.getAllByRole('textbox')[0], { target: { value: '12345', }, }); fireEvent.input(screen.getAllByRole('textbox')[1], { target: { value: 'true', }, }); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(output).toEqual({ test: 12345, test1: true })); }); it('should return undefined value with setValueAs', async () => { let output = {}; const Component = () => { const { register, handleSubmit } = useForm<{ test: number; }>(); return (
(output = data))}> value === '' ? undefined : +value, })} defaultValue={12345} />
); }; render(); fireEvent.input(screen.getByRole('textbox'), { target: { value: '', }, }); fireEvent.click(screen.getByRole('button')); expect(output).toEqual({ test: undefined }); }); it('should return NaN when value is valid', async () => { let output = {}; const Component = () => { const { register, handleSubmit } = useForm<{ test: number; }>(); return (
(output = data))}>
); }; render(); fireEvent.input(screen.getByRole('textbox'), { target: { value: '', }, }); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(output).toEqual({ test: NaN })); }); it('should validate input before the valueAs', async () => { const Component = () => { const { register, formState: { errors }, } = useForm<{ test: number; test1: number; }>({ mode: 'onChange', }); return ( <> { return !isString(data); }, })} /> {errors.test && 'Not number'} {errors.test1 && 'Number length'} ); }; render(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '123', }, }); expect(await screen.findByText('Not number')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '12', }, }); expect(await screen.findByText('Number length')).toBeVisible(); }); it('should be able to validate against formValues', async () => { const App = () => { const { register, formState: { errors }, } = useForm({ mode: 'onChange', defaultValues: { test: '', test1: '', }, }); return ( <> data === formValues.test1, })} /> {errors.test ? 'Not number' : 'No error'} ); }; render(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '1', }, }); await waitFor(() => screen.findByText('Not number')); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '11', }, }); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '11', }, }); await waitFor(() => screen.findByText('No error')); }); it('should send valueAs fields to schema validation', () => { let output: any; const Component = () => { const { register, trigger } = useForm<{ test: number; test1: any; test2: boolean; }>({ resolver: (data) => { output = data; return { values: { test: 1, test1: 2, test2: true, }, errors: {}, }; }, }); return (
data === 'test' })} />
); }; render(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: 1 }, }); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '1990' }, }); fireEvent.change(screen.getAllByRole('textbox')[2], { target: { value: 'test' }, }); fireEvent.click(screen.getByRole('button')); expect(output).toEqual({ test: 1, test1: new Date('1990'), test2: true, }); }); it('should send valueAs fields to in build validator', async () => { const Component = () => { const { register, trigger, formState: { errors }, } = useForm({ mode: 'onChange', }); return ( <> { return value === 1; }, valueAsNumber: true, })} /> {errors.test &&

test error

} { return value === 1; }, setValueAs: (value) => parseInt(value), })} /> {errors.test1 &&

test1 error

} ); }; render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('test error')).toBeVisible(); expect(screen.getByText('test1 error')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '1', }, }); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '1', }, }); await waitForElementToBeRemoved(screen.queryByText('test error')); expect(screen.queryByText('test1 error')).not.toBeInTheDocument(); }); it('should send valueAs fields to resolver', async () => { const Component = () => { const { register, trigger, formState: { errors }, } = useForm<{ test: number; test1: number; }>({ mode: 'onChange', resolver: async (data) => { const valid = !(isNaN(data.test) && isNaN(data.test1)); return { errors: valid ? {} : { test: { type: 'error', message: 'issue', }, test1: { type: 'error', message: 'issue', }, }, values: valid ? { test: 1, test1: 2, } : {}, }; }, }); return ( <> { return value === 1; }, valueAsNumber: true, })} /> {errors.test &&

test error

} { return value === 1; }, setValueAs: (value) => parseInt(value), })} /> {errors.test &&

test1 error

} ); }; render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('test error')).toBeVisible(); expect(screen.getByText('test1 error')).toBeVisible(); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '1', }, }); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '1', }, }); await waitForElementToBeRemoved(screen.queryByText('test error')); expect(screen.queryByText('test1 error')).not.toBeInTheDocument(); }); it('should still validate with an error existed', async () => { function App() { const { register, handleSubmit, setError, formState: { errors }, } = useForm<{ firstName: string }>(); const { name, ref, onBlur, onChange } = register('firstName'); return (
{ setError('firstName', { type: 'manual', message: 'Empty', }); })} > {errors.firstName &&
{errors.firstName.message}
}
); } render(); fireEvent.click(screen.getByRole('button')); expect(await screen.findByText('Empty')).toBeVisible(); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'test', }, }); await waitForElementToBeRemoved(screen.queryByText('Empty')); }); }); it('should not register nested input', () => { const watchedValue: unknown[] = []; let inputs: unknown; const Checkboxes = ({ value, onChange, }: { value: boolean[]; onChange: (value: boolean[]) => void; }) => { const [checkboxValue, setCheckboxValue] = React.useState(value); return (
{value.map((_, index) => ( { const updatedValue = checkboxValue.map((item, i) => { if (index === i) { return e.target.checked; } return item; }); setCheckboxValue(updatedValue); onChange(updatedValue); }} type="checkbox" checked={checkboxValue[index]} /> ))}
); }; function App() { const { control, watch } = useForm({ defaultValues: { test: [true, false, false], }, }); inputs = control._fields; watchedValue.push(watch()); return (
( )} /> ); } render(); fireEvent.click(screen.getAllByRole('checkbox')[0]); expect(watchedValue).toEqual([ { test: [true, false, false] }, { test: [true, false, false] }, { test: [false, false, false] }, ]); expect(inputs).toEqual({ test: { _f: { mount: true, name: 'test', ref: { name: 'test', }, value: [false, false, false], }, }, }); }); describe('when setValueAs is presented with inputs', () => { it('should not update inputs correctly with useForm defaultValues', () => { const App = () => { const { register } = useForm({ defaultValues: { test: '1234', }, }); return (
value + '5' })} />
); }; render(); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( '1234', ); }); it('should not update inputs correctly with reset', () => { const App = () => { const { register, reset } = useForm(); React.useEffect(() => { reset({ test: '1234', }); }, [reset]); return (
value + '5' })} />
); }; render(); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( '1234', ); }); it('should populate input as string and submit as datetime object ', async () => { let submitData: unknown; const App = () => { const { register, handleSubmit } = useForm<{ test: Date | string; }>({ defaultValues: { test: '2020-10-10', }, }); return (
{ submitData = data; })} >
); }; render(); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( '2020-10-10', ); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(submitData).toEqual({ test: new Date('2020-10-10'), }), ); }); }); it('should not throw error when register with non input ref', () => { const App = () => { const { register } = useForm(); return (

test

); }; render(); }); it('should be able to register input/textarea/select when embedded deeply', async () => { let submitData: unknown; const Select = React.forwardRef((_, ref) => { return (
); }); Select.displayName = 'Select'; const Input = React.forwardRef((_, ref) => { return (
); }); Input.displayName = 'Input'; const Textarea = React.forwardRef((_, ref) => { return (