Open History to see the last commit
1import { render } from 'vitest-browser-react'
2import { describe, expect, it, vi } from 'vitest'
3import React, { useState } from 'react'
4import { useForm } from '../src'
5β
6describe('useForm', () => {
7 it('should mount the form to the dom', async () => {
8 function Component() {
9 const form = useForm({ defaultValues: { name: 'tony-hawk' } })
10β
11 return (
12 <form.Field name="name">
13 {(field) => (
14 <label>
15 Name
16 <input
17 value={field.value}
18 onChange={(event) => field.handleChange(event.target.value)}
19 />
20 </label>
21 )}
22 </form.Field>
23 )
24 }
25β
26 const screen = await render(<Component />)
27β
28 expect(screen.getByRole('textbox', { name: 'Name' })).toHaveValue(
29 'tony-hawk',
30 )
31 })
32β
33 it('uses a supplied formId', async () => {
34 function Component() {
35 const form = useForm({
36 formId: 'signup-form',
37 defaultValues: { name: '' },
38 })
39β
40 return <form id={form.formId} aria-label="Signup" />
41 }
42β
43 const screen = await render(<Component />)
44β
45 expect(screen.getByRole('form', { name: 'Signup' })).toHaveAttribute(
46 'id',
47 'signup-form',
48 )
49 })
50β
51 it('creates a stable formId when one is not supplied', async () => {
52 function Component() {
53 const form = useForm({ defaultValues: { name: '' } })
54β
55 return <form id={form.formId} aria-label="Signup" />
56 }
57β
58 const screen = await render(<Component />)
59 const formElement = screen.getByRole('form', { name: 'Signup' })
60 const formId = formElement.element().id
61β
62 expect(formId.length).toBeGreaterThan(0)
63β
64 await screen.rerender(<Component />)
65β
66 expect(formElement).toHaveAttribute('id', formId)
67 })
68β
69 it('should support async defaultValues with useState', async () => {
70 function Component() {
71 const [defaultValues, setDefaultValues] = useState({ name: 'initial' })
72 const form = useForm({ defaultValues })
73β
74 return (
75 <>
76 <form.Field name="name">
77 {(field) => (
78 <label>
79 Name
80 <input
81 value={field.value}
82 onChange={(event) => field.handleChange(event.target.value)}
83 />
84 </label>
85 )}
86 </form.Field>
87 <button onClick={() => setDefaultValues({ name: 'async-value' })}>
88 Load defaults
89 </button>
90 </>
91 )
92 }
93β
94 const screen = await render(<Component />)
95 const name = screen.getByRole('textbox', { name: 'Name' })
96β
97 expect(name).toHaveValue('initial')
98β
99 await screen.getByRole('button', { name: 'Load defaults' }).click()
100β
101 expect(name).toHaveValue('async-value')
102 })
103β
104 it('should not overwrite a touched field with async defaultValues', async () => {
105 function Component() {
106 const [defaultValues, setDefaultValues] = useState({
107 name: 'initial',
108 age: 0,
109 })
110 const form = useForm({ defaultValues })
111β
112 return (
113 <>
114 <form.Field name="name">
115 {(field) => (
116 <label>
117 Name
118 <input
119 value={field.value}
120 onChange={(event) => field.handleChange(event.target.value)}
121 />
122 </label>
123 )}
124 </form.Field>
125 <form.Field name="age">
126 {(field) => (
127 <label>
128 Age
129 <input
130 type="number"
131 value={field.value}
132 onChange={(event) =>
133 field.handleChange(event.target.valueAsNumber)
134 }
135 />
136 </label>
137 )}
138 </form.Field>
139 <button
140 onClick={() => setDefaultValues({ name: 'new-default', age: 99 })}
141 >
142 Load defaults
143 </button>
144 </>
145 )
146 }
147β
148 const screen = await render(<Component />)
149 const name = screen.getByRole('textbox', { name: 'Name' })
150 const age = screen.getByRole('spinbutton', { name: 'Age' })
151β
152 expect(name).toHaveValue('initial')
153 expect(age).toHaveValue(0)
154β
155 await name.fill('touched')
156β
157 expect(name).toHaveValue('touched')
158β
159 await screen.getByRole('button', { name: 'Load defaults' }).click()
160β
161 expect(name).toHaveValue('touched')
162 expect(age).toHaveValue(99)
163 })
164β
165 it('should overwrite field B if only field A was touched and B is not a child of A', async () => {
166 function Component() {
167 const [defaultValues, setDefaultValues] = useState({
168 a: { nested: 'initial-a' },
169 b: 'initial-b',
170 })
171 const form = useForm({ defaultValues })
172β
173 return (
174 <>
175 <form.Field name="a.nested">
176 {(field) => (
177 <label>
178 Field A
179 <input
180 value={field.value}
181 onChange={(event) => field.handleChange(event.target.value)}
182 />
183 </label>
184 )}
185 </form.Field>
186 <form.Field name="b">
187 {(field) => (
188 <label>
189 Field B
190 <input
191 value={field.value}
192 onChange={(event) => field.handleChange(event.target.value)}
193 />
194 </label>
195 )}
196 </form.Field>
197 <button
198 onClick={() =>
199 setDefaultValues({ a: { nested: 'new-a' }, b: 'new-b' })
200 }
201 >
202 Load defaults
203 </button>
204 </>
205 )
206 }
207β
208 const screen = await render(<Component />)
209 const fieldA = screen.getByRole('textbox', { name: 'Field A' })
210 const fieldB = screen.getByRole('textbox', { name: 'Field B' })
211β
212 expect(fieldA).toHaveValue('initial-a')
213 expect(fieldB).toHaveValue('initial-b')
214β
215 await fieldA.fill('touched-a')
216β
217 expect(fieldA).toHaveValue('touched-a')
218β
219 await screen.getByRole('button', { name: 'Load defaults' }).click()
220β
221 expect(fieldA).toHaveValue('touched-a')
222 expect(fieldB).toHaveValue('new-b')
223 })
224β
225 it('does not render with pre-validation state for synchronous runOnMount validation', async () => {
226 const renderStates: Array<{
227 errors: Array<string>
228 isValid: boolean
229 canSubmit: boolean
230 }> = []
231β
232 function Component() {
233 const form = useForm({
234 defaultValues: { name: '' },
235 validators: [
236 {
237 runOnMount: true,
238 triggers: [],
239 run: () => 'Name is required',
240 },
241 ],
242 })
243β
244 return (
245 <form.Subscribe
246 selector={(state) => ({
247 errors: state.errors.map((error) => error.message),
248 isValid: state.isValid,
249 canSubmit: state.canSubmit,
250 })}
251 >
252 {(state) => {
253 renderStates.push(state)
254 return (
255 <output data-testid="form-state">
256 {state.errors.join(',')}|{String(state.isValid)}|
257 {String(state.canSubmit)}
258 </output>
259 )
260 }}
261 </form.Subscribe>
262 )
263 }
264β
265 const screen = await render(<Component />)
266β
267 expect(screen.getByTestId('form-state')).toHaveTextContent(
268 'Name is required|false|false',
269 )
270 expect(renderStates.length).toBeGreaterThan(0)
271 for (const state of renderStates) {
272 expect(state).toEqual({
273 errors: ['Name is required'],
274 isValid: false,
275 canSubmit: false,
276 })
277 }
278 })
279β
280 it('updates form.Subscribe selectors for isDefaultValue', async () => {
281 function Component() {
282 const form = useForm({ defaultValues: { name: 'tony-hawk' } })
283β
284 return (
285 <>
286 <button onClick={() => form.setFieldValue('name', 'rodney-mullen')}>
287 Change name
288 </button>
289 <button onClick={() => form.setFieldValue('name', 'tony-hawk')}>
290 Restore name
291 </button>
292 <form.Subscribe selector={(state) => state.isDefaultValue}>
293 {(isDefaultValue) => (
294 <output data-testid="is-default-value">
295 {String(isDefaultValue)}
296 </output>
297 )}
298 </form.Subscribe>
299 </>
300 )
301 }
302β
303 const screen = await render(<Component />)
304β
305 expect(screen.getByTestId('is-default-value')).toHaveTextContent('true')
306β
307 await screen.getByRole('button', { name: 'Change name' }).click()
308 expect(screen.getByTestId('is-default-value')).toHaveTextContent('false')
309β
310 await screen.getByRole('button', { name: 'Restore name' }).click()
311 expect(screen.getByTestId('is-default-value')).toHaveTextContent('true')
312 })
313β
314 it('does not crash when asynchronous runOnMount validation resolves after unmount', async () => {
315 let resolveValidation!: (value: string) => void
316 const validator = vi.fn(
317 () =>
318 new Promise<string>((resolve) => {
319 resolveValidation = resolve
320 }),
321 )
322β
323 function Component() {
324 const form = useForm({
325 defaultValues: { name: '' },
326 validators: [
327 {
328 runOnMount: true,
329 triggers: [],
330 run: validator,
331 },
332 ],
333 })
334β
335 return (
336 <form.Subscribe selector={(state) => state.isValidating}>
337 {(isValidating) => (
338 <output data-testid="is-validating">{String(isValidating)}</output>
339 )}
340 </form.Subscribe>
341 )
342 }
343β
344 const screen = await render(<Component />)
345β
346 expect(validator).toHaveBeenCalledOnce()
347 expect(screen.getByTestId('is-validating')).toHaveTextContent('true')
348β
349 await screen.unmount()
350β
351 await expect(
352 (async () => {
353 resolveValidation('Async mount error')
354 await Promise.resolve()
355 })(),
356 ).resolves.toBeUndefined()
357 })
358})