Open History to see the last commit
1import { render } from 'vitest-browser-preact'
2import { describe, expect, it, vi } from 'vitest'
3import { createFormHook, getFormHookHelpers } from '../src'
4import type { FieldWithValue } from '../src'
5β
6describe('createFormHook defaults', () => {
7 it('applies form, field, and form group defaults through public components', async () => {
8 const formCalls: Array<string> = []
9 const fieldCalls: Array<string> = []
10 const onSubmitInvalid = vi.fn()
11 const { useAppForm } = createFormHook({
12 fieldComponents: {},
13 formComponents: {},
14 defaultFormOptions: {
15 listenersMerge: 'append',
16 listeners: [
17 {
18 triggers: ['change'],
19 run: () => formCalls.push('default'),
20 },
21 ],
22 },
23 defaultFieldOptions: {
24 listenersMerge: 'prepend',
25 listeners: [
26 {
27 triggers: ['change'],
28 run: ({ fieldApi }) =>
29 fieldCalls.push(`default:${String(fieldApi.name)}`),
30 },
31 ],
32 },
33 defaultFormGroupOptions: {
34 onSubmitInvalid,
35 },
36 })
37β
38 function Component() {
39 const form = useAppForm({
40 defaultValues: {
41 direct: '',
42 directArray: ['one'],
43 group: {
44 field: '',
45 array: ['one'],
46 },
47 },
48 listeners: [
49 {
50 triggers: ['change'],
51 run: () => formCalls.push('local'),
52 },
53 ],
54 })
55β
56 return (
57 <>
58 <form.Field
59 name="direct"
60 listeners={[
61 {
62 triggers: ['change'],
63 run: ({ fieldApi }) =>
64 fieldCalls.push(`local:${String(fieldApi.name)}`),
65 },
66 ]}
67 >
68 {(field) => (
69 <button onClick={() => field.handleChange('changed')}>
70 Change direct field
71 </button>
72 )}
73 </form.Field>
74 <form.ArrayField name="directArray">
75 {(field) => (
76 <button
77 onClick={() => field.handleChange([...field.value, 'two'])}
78 >
79 Change direct array field
80 </button>
81 )}
82 </form.ArrayField>
83 <form.FormGroup
84 name="group"
85 validators={[
86 {
87 triggers: [],
88 run: () => 'Invalid group',
89 },
90 ]}
91 >
92 {(group) => (
93 <>
94 <group.Field name="field">
95 {(field) => (
96 <button onClick={() => field.handleChange('changed')}>
97 Change grouped field
98 </button>
99 )}
100 </group.Field>
101 <group.ArrayField name="array">
102 {(field) => (
103 <button
104 onClick={() =>
105 field.handleChange([...field.value, 'two'])
106 }
107 >
108 Change grouped array field
109 </button>
110 )}
111 </group.ArrayField>
112 <button onClick={() => void group.handleSubmit()}>
113 Submit group
114 </button>
115 </>
116 )}
117 </form.FormGroup>
118 </>
119 )
120 }
121β
122 const view = render(<Component />)
123β
124 await view.getByRole('button', { name: 'Change direct field' }).click()
125 await view
126 .getByRole('button', { name: 'Change direct array field' })
127 .click()
128 await view.getByRole('button', { name: 'Change grouped field' }).click()
129 await view
130 .getByRole('button', { name: 'Change grouped array field' })
131 .click()
132β
133 expect(formCalls).toEqual([
134 'default',
135 'local',
136 'default',
137 'local',
138 'default',
139 'local',
140 'default',
141 'local',
142 ])
143 expect(fieldCalls).toEqual([
144 'local:direct',
145 'default:direct',
146 'default:directArray',
147 'default:group.field',
148 'default:group.array',
149 ])
150β
151 await view.getByRole('button', { name: 'Submit group' }).click()
152 await vi.waitFor(() => expect(onSubmitInvalid).toHaveBeenCalledOnce())
153 })
154β
155 it('provides field context to field components inside an ArrayField', async () => {
156 let renders = 0
157β
158 function ItemCount({ field }: { field: FieldWithValue<Array<string>> }) {
159 return <span>Items: {field.value.length}</span>
160 }
161β
162 const { fieldComponent } = getFormHookHelpers()
163 const { useAppForm } = createFormHook({
164 fieldComponents: { ItemCount: fieldComponent.strict(ItemCount, 'field') },
165 formComponents: {},
166 })
167β
168 function Component() {
169 const form = useAppForm({
170 defaultValues: { tags: ['a', 'b'], group: { tags: ['c'] } },
171 })
172β
173 return (
174 <>
175 <form.ArrayField name="tags">
176 {(field) => {
177 renders++
178 return (
179 <>
180 <field.ItemCount />
181 <button type="button" onClick={() => field.pushValue('c')}>
182 Add
183 </button>
184 </>
185 )
186 }}
187 </form.ArrayField>
188 <form.FormGroup name="group">
189 {(group) => (
190 <group.ArrayField name="tags">
191 {(field) => {
192 renders++
193 return <field.ItemCount />
194 }}
195 </group.ArrayField>
196 )}
197 </form.FormGroup>
198 <button
199 type="button"
200 onClick={() => {
201 form.setFieldValue('tags[0]', 'z')
202 form.setFieldValue('group.tags[0]', 'z')
203 }}
204 >
205 Update first
206 </button>
207 </>
208 )
209 }
210β
211 const view = render(<Component />)
212β
213 expect(view.getByText('Items: 2')).toBeInTheDocument()
214 expect(view.getByText('Items: 1')).toBeInTheDocument()
215 await view.getByText('Add').click()
216 expect(view.getByText('Items: 3')).toBeInTheDocument()
217β
218 const pushRenders = renders
219 await view.getByText('Update first').click()
220 expect(renders).toBe(pushRenders)
221 })
222})