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

createField.tsx

226 lines5.4 KB

1import { FieldApi } from '@tanstack/form-core'
2import {
3 createComponent,
4 createComputed,
5 createMemo,
6 createSignal,
7 onCleanup,
8 onMount,
9} from 'solid-js'
10​
11import type {
12 DeepKeys,
13 DeepValue,
14 Narrow,
15 Validator,
16} from '@tanstack/form-core'
17import type { JSXElement } from 'solid-js'
18import type { CreateFieldOptions } from './types'
19​
20interface SolidFieldApi<
21 TParentData,
22 TFormValidator extends
23 | Validator<TParentData, unknown>
24 | undefined = undefined,
25> {
26 Field: FieldComponent<TParentData, TFormValidator>
28​
29export type CreateField<
30 TParentData,
31 TFormValidator extends
32 | Validator<TParentData, unknown>
33 | undefined = undefined,
34> = <
35 TName extends DeepKeys<TParentData>,
36 TFieldValidator extends
37 | Validator<DeepValue<TParentData, TName>, unknown>
38 | undefined = undefined,
39 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
40>(
41 opts: () => { name: Narrow<TName> } & Omit<
42 CreateFieldOptions<
43 TParentData,
44 TName,
45 TFieldValidator,
46 TFormValidator,
47 TData
48 >,
49 'form'
50 >,
51) => () => FieldApi<
52 TParentData,
53 TName,
54 TFieldValidator,
55 TFormValidator,
56 TData
57> &
58 SolidFieldApi<TParentData, TFormValidator>
59​
60// ugly way to trick solid into triggering updates for changes on the fieldApi
61function makeFieldReactive<
62 TParentData,
63 TName extends DeepKeys<TParentData>,
64 TFieldValidator extends
65 | Validator<DeepValue<TParentData, TName>, unknown>
66 | undefined = undefined,
67 TFormValidator extends
68 | Validator<TParentData, unknown>
69 | undefined = undefined,
70 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
71 FieldApiT extends FieldApi<
72 TParentData,
73 TName,
74 TFieldValidator,
75 TFormValidator,
76 TData
77 > = FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> &
78 SolidFieldApi<TParentData, TFormValidator>,
79>(fieldApi: FieldApiT): () => FieldApiT {
80 const [flag, setFlag] = createSignal(false)
81 const fieldApiMemo = createMemo(() => [flag(), fieldApi] as const)
82 const unsubscribeStore = fieldApi.store.subscribe(() => setFlag((f) => !f))
83 onCleanup(unsubscribeStore)
84 return () => fieldApiMemo()[1]
86​
87export function createField<
88 TParentData,
89 TName extends DeepKeys<TParentData>,
90 TFieldValidator extends
91 | Validator<DeepValue<TParentData, TName>, unknown>
92 | undefined = undefined,
93 TFormValidator extends
94 | Validator<TParentData, unknown>
95 | undefined = undefined,
96 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
97>(
98 opts: () => CreateFieldOptions<
99 TParentData,
100 TName,
101 TFieldValidator,
102 TFormValidator,
103 TData
104 >,
105) {
106 const options = opts()
107​
108 const api = new FieldApi(options)
109​
110 const extendedApi: typeof api & SolidFieldApi<TParentData, TFormValidator> =
111 api as never
112​
113 extendedApi.Field = Field as never
114​
115 /**
116 * fieldApi.update should not have any side effects. Think of it like a `useRef`
117 * that we need to keep updated every render with the most up-to-date information.
118 *
119 * createComputed to make sure this effect runs before render effects
120 */
121 createComputed(() => api.update(opts()))
122​
123 // Instantiates field meta and removes it when unrendered
124 onMount(() => onCleanup(api.mount()))
125​
126 return makeFieldReactive(extendedApi as never)
128​
129type FieldComponentProps<
130 TParentData,
131 TName extends DeepKeys<TParentData>,
132 TFieldValidator extends
133 | Validator<DeepValue<TParentData, TName>, unknown>
134 | undefined = undefined,
135 TFormValidator extends
136 | Validator<TParentData, unknown>
137 | undefined = undefined,
138 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
139> = {
140 children: (
141 fieldApi: () => FieldApi<
142 TParentData,
143 TName,
144 TFieldValidator,
145 TFormValidator,
146 TData
147 >,
148 ) => JSXElement
149} & Omit<
150 CreateFieldOptions<
151 TParentData,
152 TName,
153 TFieldValidator,
154 TFormValidator,
155 TData
156 >,
157 'form'
159​
160export type FieldComponent<
161 TParentData,
162 TFormValidator extends
163 | Validator<TParentData, unknown>
164 | undefined = undefined,
165> = <
166 TName extends DeepKeys<TParentData>,
167 TFieldValidator extends
168 | Validator<DeepValue<TParentData, TName>, unknown>
169 | undefined = undefined,
170 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
171>({
172 children,
173 ...fieldOptions
174}: Omit<
175 FieldComponentProps<
176 TParentData,
177 TName,
178 TFieldValidator,
179 TFormValidator,
180 TData
181 >,
182 'form'
183>) => JSXElement
184​
185export function Field<
186 TParentData,
187 TName extends DeepKeys<TParentData>,
188 TFieldValidator extends
189 | Validator<DeepValue<TParentData, TName>, unknown>
190 | undefined = undefined,
191 TFormValidator extends
192 | Validator<TParentData, unknown>
193 | undefined = undefined,
194 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
195>(
196 props: {
197 children: (
198 fieldApi: () => FieldApi<
199 TParentData,
200 TName,
201 TFieldValidator,
202 TFormValidator,
203 TData
204 >,
205 ) => JSXElement
206 } & CreateFieldOptions<
207 TParentData,
208 TName,
209 TFieldValidator,
210 TFormValidator,
211 TData
212 >,
213) {
214 const fieldApi = createField<
215 TParentData,
216 TName,
217 TFieldValidator,
218 TFormValidator,
219 TData
220 >(() => {
221 const { children, ...fieldOptions } = props
222 return fieldOptions
223 })
224​
225 return <>{createComponent(() => props.children(fieldApi), {})}</>