Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

createFormHook.spec.tsx

134 lines4.0 KB

1import { render } from 'vitest-browser-vue'
2import { Fragment, defineComponent, h } from 'vue'
3import { describe, expect, it, vi } from 'vitest'
4import { createFormHook } from '../src'
5import type { AnyFieldApi } from '../src'
6​
7describe('createFormHook defaults', () => {
8 it('applies form, field, and form group defaults through public components', async () => {
9 const formCalls: Array<string> = []
10 const fieldCalls: Array<string> = []
11 const onSubmitInvalid = vi.fn()
12 const { useAppForm } = createFormHook({
13 fieldComponents: {},
14 formComponents: {},
15 defaultFormOptions: {
16 listenersMerge: 'append',
17 listeners: [
18 {
19 triggers: ['change'],
20 run: () => formCalls.push('form'),
21 },
22 ],
23 },
24 defaultFieldOptions: {
25 listenersMerge: 'prepend',
26 listeners: [
27 {
28 triggers: ['change'],
29 run: ({ fieldApi }) => fieldCalls.push(String(fieldApi.name)),
30 },
31 ],
32 },
33 defaultFormGroupOptions: {
34 onSubmitInvalid,
35 },
36 })
37​
38 const Component = defineComponent(() => {
39 const form = useAppForm({
40 defaultValues: {
41 direct: '',
42 directArray: ['one'],
43 group: {
44 field: '',
45 array: ['one'],
46 },
47 },
48 })
49​
50 return () => (
51 <>
52 <form.Field name="direct">
53 {({ field }: { field: AnyFieldApi }) => (
54 <button onClick={() => field.handleChange('changed')}>
55 Change direct field
56 </button>
57 )}
58 </form.Field>
59 <form.ArrayField name="directArray">
60 {({ field }: { field: AnyFieldApi }) => (
61 <button
62 onClick={() =>
63 field.handleChange([...(field.value as Array<string>), 'two'])
64 }
65 >
66 Change direct array field
67 </button>
68 )}
69 </form.ArrayField>
70 <form.FormGroup
71 name="group"
72 validators={[
73 {
74 triggers: [],
75 run: () => 'Invalid group',
76 },
77 ]}
78 >
79 {({ group }: { group: any }) => (
80 <>
81 <group.Field name="field">
82 {({ field }: { field: AnyFieldApi }) => (
83 <button onClick={() => field.handleChange('changed')}>
84 Change grouped field
85 </button>
86 )}
87 </group.Field>
88 <group.ArrayField name="array">
89 {({ field }: { field: AnyFieldApi }) => (
90 <button
91 onClick={() =>
92 field.handleChange([
93 ...(field.value as Array<string>),
94 'two',
95 ])
96 }
97 >
98 Change grouped array field
99 </button>
100 )}
101 </group.ArrayField>
102 <button onClick={() => void group.handleSubmit()}>
103 Submit group
104 </button>
105 </>
106 )}
107 </form.FormGroup>
108 </>
109 )
110 })
111​
112 const view = await render(Component)
113​
114 await view.getByRole('button', { name: 'Change direct field' }).click()
115 await view
116 .getByRole('button', { name: 'Change direct array field' })
117 .click()
118 await view.getByRole('button', { name: 'Change grouped field' }).click()
119 await view
120 .getByRole('button', { name: 'Change grouped array field' })
121 .click()
122​
123 expect(formCalls).toEqual(['form', 'form', 'form', 'form'])
124 expect(fieldCalls).toEqual([
125 'direct',
126 'directArray',
127 'group.field',
128 'group.array',
129 ])
130​
131 await view.getByRole('button', { name: 'Submit group' }).click()
132 await vi.waitFor(() => expect(onSubmitInvalid).toHaveBeenCalledOnce())
133 })
134})