import React, { useEffect, useMemo, useState } from 'react'; import { fireEvent, render, screen, waitFor } from '@testing-library/react'; import { Controller } from '../controller'; import type { Control, FieldPath, FieldValues, UseFormReturn } from '../types'; import { useController } from '../useController'; import { useForm } from '../useForm'; import { FormProvider, useFormContext } from '../useFormContext'; import isBoolean from '../utils/isBoolean'; import noop from '../utils/noop'; describe('useController', () => { it('should render input correctly', () => { const Component = () => { const { control } = useForm<{ test: string; test1: { test: string }[]; }>(); useController({ name: 'test', control, defaultValue: '', }); return null; }; render(); }); it('component using the hook can be memoized', async () => { function App() { const form = useForm({ values: { login: 'john' }, }); return useMemo(() => , [form]); } function LoginField({ form }: { form: UseFormReturn<{ login: string }> }) { const ctrl = useController({ name: 'login', control: form.control, }); return ; } render(); const input = screen.getAllByRole('textbox')[0]; expect(input.value).toBe('john'); fireEvent.input(input, { target: { value: 'abc' } }); expect(input.value).toBe('abc'); }); it("setting values doesn't cause fields to be unregistered", async () => { function App() { const [values, setValues] = useState<{ login: string } | undefined>(); const form = useForm({ values, }); useEffect(() => { setTimeout(() => { setValues({ login: 'john' }); }, 100); }, []); return useMemo( () => values?.login && , [values, form], ); } function LoginField({ form }: { form: UseFormReturn<{ login: string }> }) { const ctrl = useController({ name: 'login', control: form.control, defaultValue: 'john', }); return ; } render(); const input = await screen.findByRole('textbox'); expect(input.value).toBe('john'); fireEvent.input(input, { target: { value: 'jane' } }); expect(input.value).toBe('jane'); }); it('should only subscribe to formState at each useController level', async () => { const renderCounter = [0, 0]; type FormValues = { test: string; test1: string; }; const Test = ({ control }: { control: Control }) => { const { field } = useController({ name: 'test', control, }); renderCounter[0]++; return ; }; const Test1 = ({ control }: { control: Control }) => { const { field, fieldState: { isDirty, isTouched }, } = useController({ name: 'test1', control, }); renderCounter[1]++; return (
{isDirty &&

isDirty

} {isTouched &&

isTouched

}
); }; const Component = () => { const { control } = useForm({ defaultValues: { test: '', test1: '', }, }); return (
); }; render(); expect(renderCounter).toEqual([2, 2]); fireEvent.change(screen.getAllByRole('textbox')[1], { target: { value: '1232', }, }); expect(screen.getByText('isDirty')).toBeVisible(); fireEvent.blur(screen.getAllByRole('textbox')[1]); expect(screen.getByText('isTouched')).toBeVisible(); expect(renderCounter).toEqual([2, 4]); fireEvent.change(screen.getAllByRole('textbox')[0], { target: { value: '1232', }, }); fireEvent.blur(screen.getAllByRole('textbox')[0]); expect(renderCounter).toEqual([4, 4]); }); describe('checkbox', () => { it('should work for checkbox by spread the field object', async () => { const watchResult: unknown[] = []; const Component = () => { const { control, watch } = useForm<{ test: string; }>(); watchResult.push(watch()); const { field } = useController({ name: 'test', control, defaultValue: '', }); return ; }; render(); expect(watchResult).toEqual([{}, { test: '' }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([{}, { test: '' }, { test: true }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([ {}, { test: '' }, { test: true }, { test: false }, ]); }); it('should work for checkbox by assign checked', async () => { const watchResult: unknown[] = []; const Component = () => { const { control, watch } = useForm<{ test: string; }>(); watchResult.push(watch()); const { field } = useController({ name: 'test', control, defaultValue: '', }); return ( field.onChange(e.target.checked)} /> ); }; render(); expect(watchResult).toEqual([{}, { test: '' }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([{}, { test: '' }, { test: true }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([ {}, { test: '' }, { test: true }, { test: false }, ]); }); it('should work for checkbox by assign value manually', async () => { const watchResult: unknown[] = []; const Component = () => { const { control, watch } = useForm<{ test: string; }>(); watchResult.push(watch()); const { field } = useController({ name: 'test', control, defaultValue: '', }); return ( field.onChange(e.target.checked ? e.target.value : false) } /> ); }; render(); expect(watchResult).toEqual([{}, { test: '' }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([{}, { test: '' }, { test: 'on' }]); fireEvent.click(screen.getByRole('checkbox')); expect(watchResult).toEqual([ {}, { test: '' }, { test: 'on' }, { test: false }, ]); }); }); it('should subscribe to formState update with trigger re-render at root', () => { type FormValues = { test: string; }; let counter = 0; const Test = ({ control }: { control: Control }) => { const { field, formState } = useController({ control, name: 'test', }); return ( <>

{formState.dirtyFields.test && 'dirty'}

{formState.touchedFields.test && 'touched'}

); }; const Component = () => { const { control } = useForm({ defaultValues: { test: '', }, }); counter++; return ; }; render(); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'test', }, }); fireEvent.blur(screen.getByRole('textbox')); expect(counter).toEqual(2); expect(screen.getByText('dirty')).toBeVisible(); expect(screen.getByText('touched')).toBeVisible(); }); it('should not overwrite defaultValues with defaultValue', () => { const App = () => { const { control } = useForm({ defaultValues: { test: 'bill', }, }); return ( { return ; }} control={control} name={'test'} defaultValue={'luo'} /> ); }; render(); expect((screen.getByRole('textbox') as HTMLInputElement).value).toBe( 'bill', ); }); it('should be able to update input value without ref', () => { const App = () => { const { control, setValue } = useForm(); const { field } = useController({ control, name: 'test', defaultValue: '', }); return (
); }; render(); fireEvent.click(screen.getByRole('button')); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( 'data', ); }); it('should not change reference for onChange and onBlur on input value change', () => { let counter = 0; const App = () => { const { control } = useForm(); const { field } = useController({ control, name: 'test', defaultValue: '', }); useEffect(() => { counter++; field.onBlur; field.onChange; field.ref; }, [field.onChange, field.onBlur, field.ref]); return (
); }; render(); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'b', }, }); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'bi', }, }); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'bil', }, }); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'bill', }, }); expect(counter).toEqual(1); }); it('should be able to setValue after reset', async () => { let renderCount = 0; type FormValues = { name: string; }; const Input = ({ control }: { control: Control }) => { renderCount++; const { field } = useController({ name: 'name', control, defaultValue: '', }); return ; }; function App() { const { reset, control, setValue } = useForm(); React.useEffect(() => { reset({ name: 'initial' }); }, [reset]); return (
); } render(); fireEvent.click(screen.getByRole('button')); expect((screen.getByRole('textbox') as HTMLInputElement).value).toEqual( 'test', ); expect(renderCount).toEqual(3); }); it('should invoke native validation with Controller', async () => { const setCustomValidity = jest.fn(); const reportValidity = jest.fn(); const focus = jest.fn(); const message = 'This is required'; type FormValues = { test: string; }; function Input({ control }: { control: Control }) { const { field } = useController({ control, rules: { required: message }, name: 'test', }); return (
{ field.ref({ focus, setCustomValidity, reportValidity, }); }} />
); } function App() { const { handleSubmit, control } = useForm({ defaultValues: { test: '', }, mode: 'onChange', shouldUseNativeValidation: true, }); return (
); } render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(focus).toBeCalled()); expect(setCustomValidity).toBeCalledWith(message); expect(reportValidity).toBeCalled(); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'bill', }, }); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(setCustomValidity).toBeCalledTimes(3)); expect(reportValidity).toBeCalledTimes(3); expect(focus).toBeCalledTimes(2); }); it('should update with inline defaultValue', async () => { const onSubmit = jest.fn(); const App = () => { const { control, handleSubmit } = useForm(); useController({ control, defaultValue: 'test', name: 'test' }); return (
{ onSubmit(data); })} >
); }; render(); fireEvent.click(screen.getByRole('button')); await waitFor(() => expect(onSubmit).toBeCalledWith({ test: 'test', }), ); }); it('should return defaultValues when component is not yet mounted', async () => { const defaultValues = { test: { deep: [ { test: '0', test1: '1', }, ], }, }; const App = () => { const { control, getValues } = useForm<{ test: { deep: { test: string; test1: string }[]; }; }>({ defaultValues, }); const { field } = useController({ control, name: 'test.deep.0.test', }); return (

{JSON.stringify(getValues())}

); }; render(); expect(true).toEqual(true); expect( await screen.findByText('{"test":{"deep":[{"test":"0","test1":"1"}]}}'), ).toBeVisible(); }); it('should trigger extra re-render and update latest value when setValue called during mount', async () => { const Child = () => { const { setValue } = useFormContext(); const { field: { value }, } = useController({ name: 'content', }); React.useEffect(() => { setValue('content', 'expected value'); }, [setValue]); return

{value}

; }; function App() { const methods = useForm({ defaultValues: { content: 'default', }, }); return (
); } render(); expect(await screen.findByText('expected value')).toBeVisible(); }); it('should remount with input with current formValue', () => { let data: unknown; function Input({ control, name, }: { control: Control; name: FieldPath; }) { const { field: { value }, } = useController({ control, name, shouldUnregister: true, }); data = value; return null; } const App = () => { const { control } = useForm<{ test: string; }>({ defaultValues: { test: 'test', }, }); const [toggle, setToggle] = React.useState(true); return (
{toggle && }
); }; render(); expect(data).toEqual('test'); fireEvent.click(screen.getByRole('button')); fireEvent.click(screen.getByRole('button')); expect(data).toBeUndefined(); }); it('should always get the latest value for onBlur event', async () => { const watchResults: unknown[] = []; const App = () => { const { control, watch } = useForm(); const { field } = useController({ control, name: 'test', defaultValue: '', }); watchResults.push(watch()); return ( ); }; render(); fireEvent.click(screen.getByRole('button'), { target: { value: 'test', }, }); expect(watchResults).toEqual([ {}, { test: '', }, { test: 'updated value', }, ]); }); it('should focus and select the input text', () => { const select = jest.fn(); const focus = jest.fn(); const App = () => { const { control, setFocus } = useForm({ defaultValues: { test: 'data', }, }); const { field } = useController({ control, name: 'test', }); field.ref({ select, focus, }); React.useEffect(() => { setFocus('test', { shouldSelect: true }); }, [setFocus]); return null; }; render(); expect(select).toBeCalled(); expect(focus).toBeCalled(); }); it('should update isValid correctly with strict mode', async () => { const App = () => { const form = useForm({ mode: 'onChange', defaultValues: { name: '', }, }); const { isValid } = form.formState; return ( ( )} name="name" rules={{ required: true, }} />

{isValid ? 'valid' : 'not'}

); }; render(); await waitFor(() => { screen.getByText('not'); }); }); it('should restore defaultValues with react strict mode double useEffect', () => { function Form() { return ( } /> ); } function App() { const methods = useForm({ defaultValues: { lastName: 'luo', }, }); const { formState: { dirtyFields }, } = methods; return (
{dirtyFields.lastName ? 'dirty' : 'pristine'}
); } render(); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'luo1', }, }); screen.getByText('dirty'); fireEvent.change(screen.getByRole('textbox'), { target: { value: 'luo', }, }); screen.getByText('pristine'); }); it('should disable the controller input', async () => { function Form() { const { field } = useController({ name: 'lastName', }); return

{field.disabled ? 'disabled' : ''}

; } function App() { const methods = useForm({ disabled: true, }); return (
); } render(); await waitFor(() => { screen.getByText('disabled'); }); }); it('should disable form input with disabled prop', async () => { const App = () => { const [disabled, setDisabled] = React.useState(false); const { control, watch } = useForm({ defaultValues: { test: 'test', }, }); const { field: { disabled: disabledProps }, } = useController({ control, name: 'test', disabled, }); const input = watch('test'); return (

{input}

{disabledProps ? 'disable' : 'notDisabled'}

); }; render(); screen.getByText('test'); screen.getByText('notDisabled'); fireEvent.click(screen.getByRole('button')); waitFor(() => { screen.getByText(''); screen.getByText('disable'); }); }); it('should disable form input field with disabled prop', async () => { const App = () => { const { control } = useForm(); const { field, fieldState: { invalid, isTouched, isDirty }, } = useController({ name: 'test', control, disabled: true, rules: { required: true }, }); return (
{invalid &&

invalid

} {isTouched &&

isTouched

} {isDirty &&

isDirty

}
); }; render(); await waitFor(() => { expect(screen.getByRole('textbox')).toBeDisabled(); }); }); it('should not disable form input field with disabled=false', async () => { const App = () => { const { control } = useForm(); const { field, fieldState: { invalid, isTouched, isDirty }, } = useController({ name: 'test', control, disabled: false, rules: { required: true }, }); return (
{invalid &&

invalid

} {isTouched &&

isTouched

} {isDirty &&

isDirty

}
); }; render(); await waitFor(() => { expect(screen.getByRole('textbox')).not.toBeDisabled(); }); }); it('should pass validation with disabled to set to true', () => { const callback = jest.fn(); const App = () => { const { handleSubmit, control } = useForm({ defaultValues: { test: 'test', }, }); const { field } = useController({ control, rules: { required: true, }, name: 'test', disabled: true, }); return (
); }; render(); fireEvent.click(screen.getByRole('button')); waitFor(() => { expect(callback).toBeCalled(); }); }); it('should not omit form value when disabled is not been presented', async () => { const onSubmit = jest.fn(); const App = () => { const { handleSubmit, control } = useForm({ defaultValues: { test: 'test', }, }); const [toggle, setToggle] = useState(undefined); const { field } = useController({ control, name: 'test', disabled: toggle, }); return (
{ onSubmit(data); })} >
); }; render(); fireEvent.click(screen.getByRole('button', { name: 'submit' })); await waitFor(() => expect(onSubmit).toBeCalledWith({ test: 'test', }), ); fireEvent.click(screen.getByRole('button', { name: 'toggle' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); await waitFor(() => expect(onSubmit).toBeCalledWith({ test: 'test', }), ); fireEvent.click(screen.getByRole('button', { name: 'toggle' })); fireEvent.click(screen.getByRole('button', { name: 'submit' })); await waitFor(() => expect(onSubmit).toBeCalledWith({ test: undefined, }), ); }); it('should subscribe to exact form state update', () => { type FormValues = { test: string; test_with_suffix: string; }; const renderCounter: Record = { test: 0, test_with_suffix: 0, }; const ControlledInput = ({ name, control, }: { name: keyof FormValues; control: Control; }) => { const { field, fieldState: { error, isDirty }, } = useController({ name, control, rules: { required: 'is required' }, }); renderCounter[name]++; return (
{error && (

{name} {error.message}

)} {isDirty &&

{name} isDirty

}
); }; const App = () => { const { control } = useForm({ mode: 'onBlur', defaultValues: { test: '1234', test_with_suffix: '1234', }, }); return (
); }; render(); expect(renderCounter).toEqual({ test: 2, test_with_suffix: 2 }); expect(screen.queryByText('test is required')).toBeNull(); expect(screen.queryByText('test_with_suffix is required')).toBeNull(); fireEvent.change(screen.getByRole('textbox', { name: 'test' }), { target: { value: '', }, }); fireEvent.blur(screen.getByRole('textbox', { name: 'test' })); expect(screen.getByText('test isDirty')).toBeVisible(); expect(renderCounter).toEqual({ test: 3, test_with_suffix: 2 }); fireEvent.change( screen.getByRole('textbox', { name: 'test_with_suffix' }), { target: { value: '', }, }, ); fireEvent.blur(screen.getByRole('textbox', { name: 'test_with_suffix' })); expect(screen.getByText('test_with_suffix isDirty')).toBeVisible(); expect(renderCounter).toEqual({ test: 3, test_with_suffix: 3 }); }); });