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.#host = host).addController(this)
235β
236 this.api = new FormApi<
237 TParentData,
238 TFormOnMount,
239 TFormOnChange,
240 TFormOnChangeAsync,
241 TFormOnBlur,
242 TFormOnBlurAsync,
243 TFormOnSubmit,
244 TFormOnSubmitAsync,
245 TFormOnServer,
246 TSubmitMeta
247 >(config)
248 }
249β
250 hostConnected() {
251 this.#subscription = this.api.store.subscribe(() => {
252 this.#host.requestUpdate()
253 })
254 }
255β
256 hostDisconnected() {
257 this.#subscription?.()
258 }
259β
260 field<
261 TName extends DeepKeys<TParentData>,
262 TData extends DeepValue<TParentData, TName>,
263 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
264 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
265 TOnChangeAsync extends
266 | undefined
267 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
268 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
269 TOnBlurAsync extends
270 | undefined
271 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
272 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
273 TOnSubmitAsync extends
274 | undefined
275 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
276 >(
277 fieldConfig: FieldOptions<
278 TParentData,
279 TName,
280 TData,
281 TOnMount,
282 TOnChange,
283 TOnChangeAsync,
284 TOnBlur,
285 TOnBlurAsync,
286 TOnSubmit,
287 TOnSubmitAsync
288 >,
289 render: renderCallback<
290 TParentData,
291 TName,
292 TData,
293 TOnMount,
294 TOnChange,
295 TOnChangeAsync,
296 TOnBlur,
297 TOnBlurAsync,
298 TOnSubmit,
299 TOnSubmitAsync,
300 TFormOnMount,
301 TFormOnChange,
302 TFormOnChangeAsync,
303 TFormOnBlur,
304 TFormOnBlurAsync,
305 TFormOnSubmit,
306 TFormOnSubmitAsync,
307 TFormOnServer,
308 TSubmitMeta
309 >,
310 ) {
311 return (
312 fieldDirective as unknown as fieldDirectiveType<
313 TParentData,
314 TName,
315 TData,
316 TOnMount,
317 TOnChange,
318 TOnChangeAsync,
319 TOnBlur,
320 TOnBlurAsync,
321 TOnSubmit,
322 TOnSubmitAsync,
323 TFormOnMount,
324 TFormOnChange,
325 TFormOnChangeAsync,
326 TFormOnBlur,
327 TFormOnBlurAsync,
328 TFormOnSubmit,
329 TFormOnSubmitAsync,
330 TFormOnServer,
331 TSubmitMeta
332 >
333 )(this.api, fieldConfig, render)
334 }
335}
336β
337class FieldDirective<
338 TParentData,
339 TName extends DeepKeys<TParentData>,
340 TData extends DeepValue<TParentData, TName>,
341 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
342 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
343 TOnChangeAsync extends
344 | undefined
345 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
346 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
347 TOnBlurAsync extends
348 | undefined
349 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
350 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
351 TOnSubmitAsync extends
352 | undefined
353 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
354 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
355 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
356 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
357 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
358 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
359 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
360 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
361 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
362 TSubmitMeta,
363> extends AsyncDirective {
364 #registered = false
365 #field?: FieldApi<
366 TParentData,
367 TName,
368 TData,
369 TOnMount,
370 TOnChange,
371 TOnChangeAsync,
372 TOnBlur,
373 TOnBlurAsync,
374 TOnSubmit,
375 TOnSubmitAsync,
376 TFormOnMount,
377 TFormOnChange,
378 TFormOnChangeAsync,
379 TFormOnBlur,
380 TFormOnBlurAsync,
381 TFormOnSubmit,
382 TFormOnSubmitAsync,
383 TFormOnServer,
384 TSubmitMeta
385 >
386 #unmount?: () => void
387β
388 constructor(partInfo: PartInfo) {
389 super(partInfo)
390 if (partInfo.type !== PartType.CHILD) {
391 throw new Error(
392 'The `field` directive must be used in the `child` attribute',
393 )
394 }
395 }
396β
397 update(
398 _: ElementPart,
399 [form, fieldConfig, _render]: Parameters<this['render']>,
400 ) {
401 if (!this.#registered) {
402 if (!this.#field) {
403 const options = { ...fieldConfig, form }
404β
405 this.#field = new FieldApi(options)
406 this.#unmount = this.#field.mount()
407 }
408β
409 this.#registered = true
410 }
411β
412 return this.render(form, fieldConfig, _render)
413 }
414β
415 protected disconnected() {
416 super.disconnected()
417 this.#unmount?.()
418 }
419β
420 protected reconnected() {
421 super.reconnected()
422 if (this.#field) {
423 this.#unmount = this.#field.mount()
424 }
425 }
426β
427 render(
428 _form: FormApi<
429 TParentData,
430 TFormOnMount,
431 TFormOnChange,
432 TFormOnChangeAsync,
433 TFormOnBlur,
434 TFormOnBlurAsync,
435 TFormOnSubmit,
436 TFormOnSubmitAsync,
437 TFormOnServer,
438 TSubmitMeta
439 >,
440 _fieldConfig: FieldOptions<
441 TParentData,
442 TName,
443 TData,
444 TOnMount,
445 TOnChange,
446 TOnChangeAsync,
447 TOnBlur,
448 TOnBlurAsync,
449 TOnSubmit,
450 TOnSubmitAsync
451 >,
452 _renderCallback: renderCallback<
453 TParentData,
454 TName,
455 TData,
456 TOnMount,
457 TOnChange,
458 TOnChangeAsync,
459 TOnBlur,
460 TOnBlurAsync,
461 TOnSubmit,
462 TOnSubmitAsync,
463 TFormOnMount,
464 TFormOnChange,
465 TFormOnChangeAsync,
466 TFormOnBlur,
467 TFormOnBlurAsync,
468 TFormOnSubmit,
469 TFormOnSubmitAsync,
470 TFormOnServer,
471 TSubmitMeta
472 >,
473 ) {
474 if (this.#field) {
475 return _renderCallback(this.#field)
476 }
477 return nothing
478 }
479}
480β
481const fieldDirective = directive(FieldDirective)