Open History to see the last commit
1import { FieldApi } from '@tanstack/form-core'
2import { useStore } from '@tanstack/vue-store'
3import { defineComponent, onMounted, onUnmounted, watch } from 'vue'
4import type {
5 DeepKeys,
6 DeepValue,
7 FieldAsyncValidateOrFn,
8 FieldValidateOrFn,
9 FormAsyncValidateOrFn,
10 FormValidateOrFn,
11} from '@tanstack/form-core'
12import type {
13 ComponentOptionsMixin,
14 CreateComponentPublicInstanceWithMixins,
15 EmitsOptions,
16 EmitsToProps,
17 PublicProps,
18 Ref,
19 SetupContext,
20 SlotsType,
21} from 'vue'
22import type { UseFieldOptions, UseFieldOptionsBound } from './types'
23β
24export type FieldComponent<
25 TParentData,
26 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
27 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
28 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
29 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
30 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
31 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
32 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
33 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
34 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
35 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
36 TParentSubmitMeta,
37 // This complex type comes from Vue's return type for `DefineSetupFnComponent` but with our own types sprinkled in
38 // This allows us to pre-bind some generics while keeping the props type unbound generics for props-based inferencing
39> = new <
40 TName extends DeepKeys<TParentData>,
41 TData extends DeepValue<TParentData, TName>,
42 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
43 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
44 TOnChangeAsync extends
45 | undefined
46 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
47 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
48 TOnBlurAsync extends
49 | undefined
50 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
51 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
52 TOnSubmitAsync extends
53 | undefined
54 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
55 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
56 TOnDynamicAsync extends
57 | undefined
58 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
59>(
60 props: FieldComponentBoundProps<
61 TParentData,
62 TName,
63 TData,
64 TOnMount,
65 TOnChange,
66 TOnChangeAsync,
67 TOnBlur,
68 TOnBlurAsync,
69 TOnSubmit,
70 TOnSubmitAsync,
71 TOnDynamic,
72 TOnDynamicAsync
73 > &
74 EmitsToProps<EmitsOptions> &
75 PublicProps,
76) => CreateComponentPublicInstanceWithMixins<
77 FieldComponentBoundProps<
78 TParentData,
79 TName,
80 TData,
81 TOnMount,
82 TOnChange,
83 TOnChangeAsync,
84 TOnBlur,
85 TOnBlurAsync,
86 TOnSubmit,
87 TOnSubmitAsync,
88 TOnDynamic,
89 TOnDynamicAsync
90 >,
91 {},
92 {},
93 {},
94 {},
95 ComponentOptionsMixin,
96 ComponentOptionsMixin,
97 EmitsOptions,
98 PublicProps,
99 {},
100 false,
101 {},
102 SlotsType<{
103 default: {
104 field: FieldApi<
105 TParentData,
106 TName,
107 TData,
108 TOnMount,
109 TOnChange,
110 TOnChangeAsync,
111 TOnBlur,
112 TOnBlurAsync,
113 TOnSubmit,
114 TOnSubmitAsync,
115 TOnDynamic,
116 TOnDynamicAsync,
117 TFormOnMount,
118 TFormOnChange,
119 TFormOnChangeAsync,
120 TFormOnBlur,
121 TFormOnBlurAsync,
122 TFormOnSubmit,
123 TFormOnSubmitAsync,
124 TFormOnDynamic,
125 TFormOnDynamicAsync,
126 TFormOnServer,
127 TParentSubmitMeta
128 >
129 state: FieldApi<
130 TParentData,
131 TName,
132 TData,
133 TOnMount,
134 TOnChange,
135 TOnChangeAsync,
136 TOnBlur,
137 TOnBlurAsync,
138 TOnSubmit,
139 TOnSubmitAsync,
140 TOnDynamic,
141 TOnDynamicAsync,
142 TFormOnMount,
143 TFormOnChange,
144 TFormOnChangeAsync,
145 TFormOnBlur,
146 TFormOnBlurAsync,
147 TFormOnSubmit,
148 TFormOnSubmitAsync,
149 TFormOnDynamic,
150 TFormOnDynamicAsync,
151 TFormOnServer,
152 TParentSubmitMeta
153 >['state']
154 }
155 }>
156>
157β
158export interface VueFieldApi<
159 TParentData,
160 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
161 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
162 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
163 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
164 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
165 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
166 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
167 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
168 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
169 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
170 TParentSubmitMeta,
171> {
172 Field: FieldComponent<
173 TParentData,
174 TFormOnMount,
175 TFormOnChange,
176 TFormOnChangeAsync,
177 TFormOnBlur,
178 TFormOnBlurAsync,
179 TFormOnSubmit,
180 TFormOnSubmitAsync,
181 TFormOnDynamic,
182 TFormOnDynamicAsync,
183 TFormOnServer,
184 TParentSubmitMeta
185 >
186}
187β
188export type UseField<
189 TParentData,
190 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
191 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
192 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
193 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
194 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
195 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
196 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
197 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
198 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
199 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
200 TParentSubmitMeta,
201> = <
202 TName extends DeepKeys<TParentData>,
203 TData extends DeepValue<TParentData, TName>,
204 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
205 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
206 TOnChangeAsync extends
207 | undefined
208 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
209 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
210 TOnBlurAsync extends
211 | undefined
212 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
213 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
214 TOnSubmitAsync extends
215 | undefined
216 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
217 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
218 TOnDynamicAsync extends
219 | undefined
220 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
221>(
222 opts: UseFieldOptionsBound<
223 TParentData,
224 TName,
225 TData,
226 TOnMount,
227 TOnChange,
228 TOnChangeAsync,
229 TOnBlur,
230 TOnBlurAsync,
231 TOnSubmit,
232 TOnSubmitAsync,
233 TOnDynamic,
234 TOnDynamicAsync
235 >,
236) => {
237 api: FieldApi<
238 TParentData,
239 TName,
240 TData,
241 TOnMount,
242 TOnChange,
243 TOnChangeAsync,
244 TOnBlur,
245 TOnBlurAsync,
246 TOnSubmit,
247 TOnSubmitAsync,
248 TOnDynamic,
249 TOnDynamicAsync,
250 TFormOnMount,
251 TFormOnChange,
252 TFormOnChangeAsync,
253 TFormOnBlur,
254 TFormOnBlurAsync,
255 TFormOnSubmit,
256 TFormOnSubmitAsync,
257 TFormOnDynamic,
258 TFormOnDynamicAsync,
259 TFormOnServer,
260 TParentSubmitMeta
261 > &
262 VueFieldApi<
263 TParentData,
264 TFormOnMount,
265 TFormOnChange,
266 TFormOnChangeAsync,
267 TFormOnBlur,
268 TFormOnBlurAsync,
269 TFormOnSubmit,
270 TFormOnSubmitAsync,
271 TFormOnDynamic,
272 TFormOnDynamicAsync,
273 TFormOnServer,
274 TParentSubmitMeta
275 >
276 state: Readonly<
277 Ref<
278 FieldApi<
279 TParentData,
280 TName,
281 TData,
282 TOnMount,
283 TOnChange,
284 TOnChangeAsync,
285 TOnBlur,
286 TOnBlurAsync,
287 TOnSubmit,
288 TOnSubmitAsync,
289 TOnDynamic,
290 TOnDynamicAsync,
291 TFormOnMount,
292 TFormOnChange,
293 TFormOnChangeAsync,
294 TFormOnBlur,
295 TFormOnBlurAsync,
296 TFormOnSubmit,
297 TFormOnSubmitAsync,
298 TFormOnDynamic,
299 TFormOnDynamicAsync,
300 TFormOnServer,
301 TParentSubmitMeta
302 >['state']
303 >
304 >
305}
306β
307export function useField<
308 TParentData,
309 TName extends DeepKeys<TParentData>,
310 TData extends DeepValue<TParentData, TName>,
311 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
312 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
313 TOnChangeAsync extends
314 | undefined
315 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
316 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
317 TOnBlurAsync extends
318 | undefined
319 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
320 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
321 TOnSubmitAsync extends
322 | undefined
323 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
324 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
325 TOnDynamicAsync extends
326 | undefined
327 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
328 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
329 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
330 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
331 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
332 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
333 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
334 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
335 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
336 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
337 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
338 TParentSubmitMeta,
339>(
340 opts: UseFieldOptions<
341 TParentData,
342 TName,
343 TData,
344 TOnMount,
345 TOnChange,
346 TOnChangeAsync,
347 TOnBlur,
348 TOnBlurAsync,
349 TOnSubmit,
350 TOnSubmitAsync,
351 TOnDynamic,
352 TOnDynamicAsync,
353 TFormOnMount,
354 TFormOnChange,
355 TFormOnChangeAsync,
356 TFormOnBlur,
357 TFormOnBlurAsync,
358 TFormOnSubmit,
359 TFormOnSubmitAsync,
360 TFormOnDynamic,
361 TFormOnDynamicAsync,
362 TFormOnServer,
363 TParentSubmitMeta
364 >,
365) {
366 const fieldApi = (() => {
367 const api = new FieldApi({
368 ...opts,
369 form: opts.form,
370 name: opts.name,
371 })
372β
373 const extendedApi: typeof api &
374 VueFieldApi<
375 TParentData,
376 TFormOnMount,
377 TFormOnChange,
378 TFormOnChangeAsync,
379 TFormOnBlur,
380 TFormOnBlurAsync,
381 TFormOnSubmit,
382 TFormOnSubmitAsync,
383 TFormOnDynamic,
384 TFormOnDynamicAsync,
385 TFormOnServer,
386 TParentSubmitMeta
387 > = api as never
388β
389 extendedApi.Field = Field as never
390β
391 return extendedApi
392 })()
393β
394 const fieldState = useStore(fieldApi.store, (state) => state)
395β
396 let cleanup!: () => void
397 onMounted(() => {
398 cleanup = fieldApi.mount()
399 })
400β
401 onUnmounted(() => {
402 cleanup()
403 })
404β
405 watch(
406 () => opts,
407 () => {
408 // Keep options up to date as they are rendered
409 fieldApi.update({ ...opts, form: opts.form } as never)
410 },
411 )
412β
413 return { api: fieldApi, state: fieldState } as const
414}
415β
416export type FieldComponentProps<
417 TParentData,
418 TName extends DeepKeys<TParentData>,
419 TData extends DeepValue<TParentData, TName>,
420 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
421 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
422 TOnChangeAsync extends
423 | undefined
424 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
425 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
426 TOnBlurAsync extends
427 | undefined
428 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
429 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
430 TOnSubmitAsync extends
431 | undefined
432 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
433 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
434 TOnDynamicAsync extends
435 | undefined
436 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
437 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
438 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
439 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
440 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
441 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
442 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
443 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
444 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
445 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
446 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
447 TParentSubmitMeta,
448> = UseFieldOptions<
449 TParentData,
450 TName,
451 TData,
452 TOnMount,
453 TOnChange,
454 TOnChangeAsync,
455 TOnBlur,
456 TOnBlurAsync,
457 TOnSubmit,
458 TOnSubmitAsync,
459 TOnDynamic,
460 TOnDynamicAsync,
461 TFormOnMount,
462 TFormOnChange,
463 TFormOnChangeAsync,
464 TFormOnBlur,
465 TFormOnBlurAsync,
466 TFormOnSubmit,
467 TFormOnSubmitAsync,
468 TFormOnDynamic,
469 TFormOnDynamicAsync,
470 TFormOnServer,
471 TParentSubmitMeta
472>
473β
474export type FieldComponentBoundProps<
475 TParentData,
476 TName extends DeepKeys<TParentData>,
477 TData extends DeepValue<TParentData, TName>,
478 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
479 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
480 TOnChangeAsync extends
481 | undefined
482 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
483 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
484 TOnBlurAsync extends
485 | undefined
486 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
487 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
488 TOnSubmitAsync extends
489 | undefined
490 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
491 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
492 TOnDynamicAsync extends
493 | undefined
494 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
495> = UseFieldOptionsBound<
496 TParentData,
497 TName,
498 TData,
499 TOnMount,
500 TOnChange,
501 TOnChangeAsync,
502 TOnBlur,
503 TOnBlurAsync,
504 TOnSubmit,
505 TOnSubmitAsync,
506 TOnDynamic,
507 TOnDynamicAsync
508>
509β
510export const Field = defineComponent(
511 <
512 TParentData,
513 TName extends DeepKeys<TParentData>,
514 TData extends DeepValue<TParentData, TName>,
515 TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
516 TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
517 TOnChangeAsync extends
518 | undefined
519 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
520 TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
521 TOnBlurAsync extends
522 | undefined
523 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
524 TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
525 TOnSubmitAsync extends
526 | undefined
527 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
528 TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>,
529 TOnDynamicAsync extends
530 | undefined
531 | FieldAsyncValidateOrFn<TParentData, TName, TData>,
532 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
533 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
534 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
535 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
536 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
537 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
538 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
539 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
540 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
541 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
542 TParentSubmitMeta,
543 >(
544 fieldOptions: UseFieldOptions<
545 TParentData,
546 TName,
547 TData,
548 TOnMount,
549 TOnChange,
550 TOnChangeAsync,
551 TOnBlur,
552 TOnBlurAsync,
553 TOnSubmit,
554 TOnSubmitAsync,
555 TOnDynamic,
556 TOnDynamicAsync,
557 TFormOnMount,
558 TFormOnChange,
559 TFormOnChangeAsync,
560 TFormOnBlur,
561 TFormOnBlurAsync,
562 TFormOnSubmit,
563 TFormOnSubmitAsync,
564 TFormOnDynamic,
565 TFormOnDynamicAsync,
566 TFormOnServer,
567 TParentSubmitMeta
568 >,
569 context: SetupContext,
570 ) => {
571 const fieldApi = useField({ ...fieldOptions, ...context.attrs })
572β
573 return () =>
574 context.slots.default!({
575 field: fieldApi.api,
576 state: fieldApi.state.value,
577 })
578 },
579 { name: 'Field', inheritAttrs: false },
580)