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

createFormHook.test-d.tsx

87 lines1.9 KB

1import Preact from 'preact/compat'
2import { expectTypeOf } from 'vitest'
3import { createFormHook } from '../src'
4​
5const { useAppForm } = createFormHook({
6 fieldComponents: {},
7 formComponents: {},
8 defaultFormOptions: {
9 listenersMerge: 'append',
10 listeners: [
11 {
12 triggers: [],
13 run: ({ value }) => {
14 expectTypeOf(value).toBeUnknown()
15 },
16 },
17 ],
18 },
19 defaultFieldOptions: {
20 listenersMerge: 'prepend',
21 listeners: [
22 {
23 triggers: [],
24 run: ({ value, fieldApi }) => {
25 expectTypeOf(value).toBeUnknown()
26 expectTypeOf(fieldApi.value).toBeUnknown()
27 },
28 },
29 ],
30 },
31 defaultFormGroupOptions: {
32 onSubmitInvalid: ({ value, groupApi }) => {
33 expectTypeOf(value).toBeUnknown()
34 expectTypeOf(groupApi.value).toBeUnknown()
35 },
36 },
37})
38​
39function InferenceRemainsLocal() {
40 const form = useAppForm({
41 defaultValues: {
42 name: '',
43 tags: [''],
44 group: { count: 0 },
45 },
46 })
47​
48 expectTypeOf(form.state.values).toEqualTypeOf<{
49 name: string
50 tags: Array<string>
51 group: { count: number }
52 }>()
53​
54 return (
55 <>
56 <form.Field name="name">
57 {(field) => {
58 expectTypeOf(field.value).toEqualTypeOf<string>()
59 return null
60 }}
61 </form.Field>
62 <form.ArrayField name="tags">
63 {(field) => {
64 expectTypeOf(field.value).toEqualTypeOf<Array<string>>()
65 return null
66 }}
67 </form.ArrayField>
68 <form.FormGroup name="group">
69 {(group) => {
70 expectTypeOf(group.value).toEqualTypeOf<{ count: number }>()
71 return null
72 }}
73 </form.FormGroup>
74 </>
75 )
77​
78void InferenceRemainsLocal
79​
80createFormHook({
81 fieldComponents: {},
82 formComponents: {},
83 defaultFormOptions: {
84 // @ts-expect-error formId belongs to an individual form instance
85 formId: 'profile',
86 },
87})