Open History to see the last commit
1import { nothing } from 'lit'
2import { PartType, directive } from 'lit/directive.js'
3import { FieldApi, FormApi } from '@tanstack/form-core'
4import { AsyncDirective } from 'lit/async-directive.js'
5import type {
6 DeepKeys,
7 DeepValue,
8 FieldAsyncValidateOrFn,
9 FieldOptions,
10 FieldValidateOrFn,
11 FormAsyncValidateOrFn,
12 FormOptions,
13 FormValidateOrFn,
14} from '@tanstack/form-core'
15import type { ElementPart, PartInfo } from 'lit/directive.js'
16import type { ReactiveController, ReactiveControllerHost } from 'lit'
17β
18type renderCallback<
19 TParentData,
20 TName extends DeepKeys<TParentData>,
21 TData extends DeepValue<TParentData, TName>,
22 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
23 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
24 TOnChangeAsync extends
25 | undefined
26 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
27 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
28 TOnBlurAsync extends
29 | undefined
30 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
31 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
32 TOnSubmitAsync extends
33 | undefined
34 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
35 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
36 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
37 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
38 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
39 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
40 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
41 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
42 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
43 TParentSubmitMeta,
44> = (
45 fieldOptions: FieldApi<
46 TParentData,
47 TName,
48 TData,
49 TOnMount,
50 TOnChange,
51 TOnChangeAsync,
52 TOnBlur,
53 TOnBlurAsync,
54 TOnSubmit,
55 TOnSubmitAsync,
56 TFormOnMount,
57 TFormOnChange,
58 TFormOnChangeAsync,
59 TFormOnBlur,
60 TFormOnBlurAsync,
61 TFormOnSubmit,
62 TFormOnSubmitAsync,
63 TFormOnServer,
64 TParentSubmitMeta
65 >,
66) => unknown
67β
68type fieldDirectiveType<
69 TParentData,
70 TName extends DeepKeys<TParentData>,
71 TData extends DeepValue<TParentData, TName>,
72 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
73 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
74 TOnChangeAsync extends
75 | undefined
76 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
77 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
78 TOnBlurAsync extends
79 | undefined
80 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
81 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
82 TOnSubmitAsync extends
83 | undefined
84 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
85 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
86 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
87 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
88 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
89 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
90 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
91 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
92 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
93 TSubmitMeta,
94> = (
95 form: FormApi<
96 TParentData,
97 TFormOnMount,
98 TFormOnChange,
99 TFormOnChangeAsync,
100 TFormOnBlur,
101 TFormOnBlurAsync,
102 TFormOnSubmit,
103 TFormOnSubmitAsync,
104 TFormOnServer,
105 TSubmitMeta
106 >,
107 options: FieldOptions<
108 TParentData,
109 TName,
110 TData,
111 TOnMount,
112 TOnChange,
113 TOnChangeAsync,
114 TOnBlur,
115 TOnBlurAsync,
116 TOnSubmit,
117 TOnSubmitAsync
118 >,
119 render: renderCallback<
120 TParentData,
121 TName,
122 TData,
123 TOnMount,
124 TOnChange,
125 TOnChangeAsync,
126 TOnBlur,
127 TOnBlurAsync,
128 TOnSubmit,
129 TOnSubmitAsync,
130 TFormOnMount,
131 TFormOnChange,
132 TFormOnChangeAsync,
133 TFormOnBlur,
134 TFormOnBlurAsync,
135 TFormOnSubmit,
136 TFormOnSubmitAsync,
137 TFormOnServer,
138 TSubmitMeta
139 >,
140) => {
141 values: {
142 form: FormApi<
143 TParentData,
144 TFormOnMount,
145 TFormOnChange,
146 TFormOnChangeAsync,
147 TFormOnBlur,
148 TFormOnBlurAsync,
149 TFormOnSubmit,
150 TFormOnSubmitAsync,
151 TFormOnServer,
152 TSubmitMeta
153 >
154 options: FieldOptions<
155 TParentData,
156 TName,
157 TData,
158 TOnMount,
159 TOnChange,
160 TOnChangeAsync,
161 TOnBlur,
162 TOnBlurAsync,
163 TOnSubmit,
164 TOnSubmitAsync
165 >
166 render: renderCallback<
167 TParentData,
168 TName,
169 TData,
170 TOnMount,
171 TOnChange,
172 TOnChangeAsync,
173 TOnBlur,
174 TOnBlurAsync,
175 TOnSubmit,
176 TOnSubmitAsync,
177 TFormOnMount,
178 TFormOnChange,
179 TFormOnChangeAsync,
180 TFormOnBlur,
181 TFormOnBlurAsync,
182 TFormOnSubmit,
183 TFormOnSubmitAsync,
184 TFormOnServer,
185 TSubmitMeta
186 >
187 }
188}
189β
190export class TanStackFormController<
191 TParentData,
192 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
193 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
194 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
195 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
196 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
197 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
198 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
199 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
200 TSubmitMeta,
201> implements ReactiveController
202{
203 #host: ReactiveControllerHost
204 #subscription?: () => void
205β
206 api: FormApi<
207 TParentData,
208 TFormOnMount,
209 TFormOnChange,
210 TFormOnChangeAsync,
211 TFormOnBlur,
212 TFormOnBlurAsync,
213 TFormOnSubmit,
214 TFormOnSubmitAsync,
215 TFormOnServer,
216 TSubmitMeta
217 >
218β
219 constructor(
220 host: ReactiveControllerHost,
221 config?: FormOptions<
222 TParentData,
223 TFormOnMount,
224 TFormOnChange,
225 TFormOnChangeAsync,
226 TFormOnBlur,
227 TFormOnBlurAsync,
228 TFormOnSubmit,
229 TFormOnSubmitAsync,
230 TFormOnServer,
231 TSubmitMeta
232 >,
233 ) {
234 this.api = new FormApi<
235 TParentData,
236 TFormOnMount,
237 TFormOnChange,
238 TFormOnChangeAsync,
239 TFormOnBlur,
240 TFormOnBlurAsync,
241 TFormOnSubmit,
242 TFormOnSubmitAsync,
243 TFormOnServer,
244 TSubmitMeta
245 >(config)
246 ;(this.#host = host).addController(this)
247 }
248β
249 hostConnected() {
250 this.#subscription = this.api.store.subscribe(() => {
251 this.#host.requestUpdate()
252 })
253 }
254β
255 hostDisconnected() {
256 this.#subscription?.()
257 }
258β
259 field<
260 TName extends DeepKeys<TParentData>,
261 TData extends DeepValue<TParentData, TName>,
262 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
263 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
264 TOnChangeAsync extends
265 | undefined
266 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
267 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
268 TOnBlurAsync extends
269 | undefined
270 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
271 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
272 TOnSubmitAsync extends
273 | undefined
274 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
275 >(
276 fieldConfig: FieldOptions<
277 TParentData,
278 TName,
279 TData,
280 TOnMount,
281 TOnChange,
282 TOnChangeAsync,
283 TOnBlur,
284 TOnBlurAsync,
285 TOnSubmit,
286 TOnSubmitAsync
287 >,
288 render: renderCallback<
289 TParentData,
290 TName,
291 TData,
292 TOnMount,
293 TOnChange,
294 TOnChangeAsync,
295 TOnBlur,
296 TOnBlurAsync,
297 TOnSubmit,
298 TOnSubmitAsync,
299 TFormOnMount,
300 TFormOnChange,
301 TFormOnChangeAsync,
302 TFormOnBlur,
303 TFormOnBlurAsync,
304 TFormOnSubmit,
305 TFormOnSubmitAsync,
306 TFormOnServer,
307 TSubmitMeta
308 >,
309 ) {
310 return (
311 fieldDirective as unknown as fieldDirectiveType<
312 TParentData,
313 TName,
314 TData,
315 TOnMount,
316 TOnChange,
317 TOnChangeAsync,
318 TOnBlur,
319 TOnBlurAsync,
320 TOnSubmit,
321 TOnSubmitAsync,
322 TFormOnMount,
323 TFormOnChange,
324 TFormOnChangeAsync,
325 TFormOnBlur,
326 TFormOnBlurAsync,
327 TFormOnSubmit,
328 TFormOnSubmitAsync,
329 TFormOnServer,
330 TSubmitMeta
331 >
332 )(this.api, fieldConfig, render)
333 }
334}
335β
336class FieldDirective<
337 TParentData,
338 TName extends DeepKeys<TParentData>,
339 TData extends DeepValue<TParentData, TName>,
340 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
341 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
342 TOnChangeAsync extends
343 | undefined
344 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
345 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
346 TOnBlurAsync extends
347 | undefined
348 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
349 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
350 TOnSubmitAsync extends
351 | undefined
352 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
353 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
354 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
355 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
356 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
357 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
358 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
359 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
360 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
361 TSubmitMeta,
362> extends AsyncDirective {
363 #registered = false
364 #field?: FieldApi<
365 TParentData,
366 TName,
367 TData,
368 TOnMount,
369 TOnChange,
370 TOnChangeAsync,
371 TOnBlur,
372 TOnBlurAsync,
373 TOnSubmit,
374 TOnSubmitAsync,
375 TFormOnMount,
376 TFormOnChange,
377 TFormOnChangeAsync,
378 TFormOnBlur,
379 TFormOnBlurAsync,
380 TFormOnSubmit,
381 TFormOnSubmitAsync,
382 TFormOnServer,
383 TSubmitMeta
384 >
385 #unmount?: () => void
386β
387 constructor(partInfo: PartInfo) {
388 super(partInfo)
389 if (partInfo.type !== PartType.CHILD) {
390 throw new Error(
391 'The `field` directive must be used in the `child` attribute',
392 )
393 }
394 }
395β
396 update(
397 _: ElementPart,
398 [form, fieldConfig, _render]: Parameters<this['render']>,
399 ) {
400 if (!this.#registered) {
401 if (!this.#field) {
402 const options = { ...fieldConfig, form }
403β
404 this.#field = new FieldApi(options)
405 this.#unmount = this.#field.mount()
406 }
407β
408 this.#registered = true
409 }
410β
411 return this.render(form, fieldConfig, _render)
412 }
413β
414 protected disconnected() {
415 super.disconnected()
416 this.#unmount?.()
417 }
418β
419 protected reconnected() {
420 super.reconnected()
421 if (this.#field) {
422 this.#unmount = this.#field.mount()
423 }
424 }
425β
426 render(
427 _form: FormApi<
428 TParentData,
429 TFormOnMount,
430 TFormOnChange,
431 TFormOnChangeAsync,
432 TFormOnBlur,
433 TFormOnBlurAsync,
434 TFormOnSubmit,
435 TFormOnSubmitAsync,
436 TFormOnServer,
437 TSubmitMeta
438 >,
439 _fieldConfig: FieldOptions<
440 TParentData,
441 TName,
442 TData,
443 TOnMount,
444 TOnChange,
445 TOnChangeAsync,
446 TOnBlur,
447 TOnBlurAsync,
448 TOnSubmit,
449 TOnSubmitAsync
450 >,
451 _renderCallback: renderCallback<
452 TParentData,
453 TName,
454 TData,
455 TOnMount,
456 TOnChange,
457 TOnChangeAsync,
458 TOnBlur,
459 TOnBlurAsync,
460 TOnSubmit,
461 TOnSubmitAsync,
462 TFormOnMount,
463 TFormOnChange,
464 TFormOnChangeAsync,
465 TFormOnBlur,
466 TFormOnBlurAsync,
467 TFormOnSubmit,
468 TFormOnSubmitAsync,
469 TFormOnServer,
470 TSubmitMeta
471 >,
472 ) {
473 if (this.#field) {
474 return _renderCallback(this.#field)
475 }
476 return nothing
477 }
478}
479β
480const fieldDirective = directive(FieldDirective)