Open History to see the last commit
1import { FormApi } from '@tanstack/form-core'
2import { useStore } from '@tanstack/vue-store'
3import { defineComponent, h, onMounted } from 'vue'
4import { Field, useField } from './useField'
5import type {
6 FormAsyncValidateOrFn,
7 FormOptions,
8 FormState,
9 FormValidateOrFn,
10} from '@tanstack/form-core'
11import type {
12 ComponentOptionsMixin,
13 CreateComponentPublicInstanceWithMixins,
14 EmitsOptions,
15 EmitsToProps,
16 PublicProps,
17 Ref,
18 SlotsType,
19} from 'vue'
20import type { FieldComponent, UseField } from './useField'
21β
22type SubscribeComponent<
23 TParentData,
24 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
25 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
26 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
27 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
28 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
29 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
30 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
31 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
32 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
33 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
34> =
35 // This complex type comes from Vue's return type for `DefineSetupFnComponent` but with our own types sprinkled in
36 // This allows us to pre-bind some generics while keeping the props type unbound generics for props-based inferencing
37 new <
38 TSelected = NoInfer<
39 FormState<
40 TParentData,
41 TFormOnMount,
42 TFormOnChange,
43 TFormOnChangeAsync,
44 TFormOnBlur,
45 TFormOnBlurAsync,
46 TFormOnSubmit,
47 TFormOnSubmitAsync,
48 TFormOnDynamic,
49 TFormOnDynamicAsync,
50 TFormOnServer
51 >
52 >,
53 >(
54 props: {
55 selector?: (
56 state: NoInfer<
57 FormState<
58 TParentData,
59 TFormOnMount,
60 TFormOnChange,
61 TFormOnChangeAsync,
62 TFormOnBlur,
63 TFormOnBlurAsync,
64 TFormOnSubmit,
65 TFormOnSubmitAsync,
66 TFormOnDynamic,
67 TFormOnDynamicAsync,
68 TFormOnServer
69 >
70 >,
71 ) => TSelected
72 } & EmitsToProps<EmitsOptions> &
73 PublicProps,
74 ) => CreateComponentPublicInstanceWithMixins<
75 {
76 selector?: (
77 state: NoInfer<
78 FormState<
79 TParentData,
80 TFormOnMount,
81 TFormOnChange,
82 TFormOnChangeAsync,
83 TFormOnBlur,
84 TFormOnBlurAsync,
85 TFormOnSubmit,
86 TFormOnSubmitAsync,
87 TFormOnDynamic,
88 TFormOnDynamicAsync,
89 TFormOnServer
90 >
91 >,
92 ) => TSelected
93 },
94 {},
95 {},
96 {},
97 {},
98 ComponentOptionsMixin,
99 ComponentOptionsMixin,
100 EmitsOptions,
101 PublicProps,
102 {},
103 false,
104 {},
105 SlotsType<{
106 default: NoInfer<
107 FormState<
108 TParentData,
109 TFormOnMount,
110 TFormOnChange,
111 TFormOnChangeAsync,
112 TFormOnBlur,
113 TFormOnBlurAsync,
114 TFormOnSubmit,
115 TFormOnSubmitAsync,
116 TFormOnDynamic,
117 TFormOnDynamicAsync,
118 TFormOnServer
119 >
120 >
121 }>
122 >
123β
124export interface VueFormApi<
125 TParentData,
126 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
127 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
128 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
129 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
130 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
131 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
132 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
133 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
134 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
135 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
136 TSubmitMeta,
137> {
138 Field: FieldComponent<
139 TParentData,
140 TFormOnMount,
141 TFormOnChange,
142 TFormOnChangeAsync,
143 TFormOnBlur,
144 TFormOnBlurAsync,
145 TFormOnSubmit,
146 TFormOnSubmitAsync,
147 TFormOnDynamic,
148 TFormOnDynamicAsync,
149 TFormOnServer,
150 TSubmitMeta
151 >
152 useField: UseField<
153 TParentData,
154 TFormOnMount,
155 TFormOnChange,
156 TFormOnChangeAsync,
157 TFormOnBlur,
158 TFormOnBlurAsync,
159 TFormOnSubmit,
160 TFormOnSubmitAsync,
161 TFormOnDynamic,
162 TFormOnDynamicAsync,
163 TFormOnServer,
164 TSubmitMeta
165 >
166 useStore: <
167 TSelected = NoInfer<
168 FormState<
169 TParentData,
170 TFormOnMount,
171 TFormOnChange,
172 TFormOnChangeAsync,
173 TFormOnBlur,
174 TFormOnBlurAsync,
175 TFormOnSubmit,
176 TFormOnSubmitAsync,
177 TFormOnDynamic,
178 TFormOnDynamicAsync,
179 TFormOnServer
180 >
181 >,
182 >(
183 selector?: (
184 state: NoInfer<
185 FormState<
186 TParentData,
187 TFormOnMount,
188 TFormOnChange,
189 TFormOnChangeAsync,
190 TFormOnBlur,
191 TFormOnBlurAsync,
192 TFormOnSubmit,
193 TFormOnSubmitAsync,
194 TFormOnDynamic,
195 TFormOnDynamicAsync,
196 TFormOnServer
197 >
198 >,
199 ) => TSelected,
200 ) => Readonly<Ref<TSelected>>
201 Subscribe: SubscribeComponent<
202 TParentData,
203 TFormOnMount,
204 TFormOnChange,
205 TFormOnChangeAsync,
206 TFormOnBlur,
207 TFormOnBlurAsync,
208 TFormOnSubmit,
209 TFormOnSubmitAsync,
210 TFormOnDynamic,
211 TFormOnDynamicAsync,
212 TFormOnServer
213 >
214}
215β
216export function useForm<
217 TParentData,
218 TFormOnMount extends undefined | FormValidateOrFn<TParentData>,
219 TFormOnChange extends undefined | FormValidateOrFn<TParentData>,
220 TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
221 TFormOnBlur extends undefined | FormValidateOrFn<TParentData>,
222 TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
223 TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>,
224 TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
225 TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>,
226 TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>,
227 TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>,
228 TSubmitMeta,
229>(
230 opts?: FormOptions<
231 TParentData,
232 TFormOnMount,
233 TFormOnChange,
234 TFormOnChangeAsync,
235 TFormOnBlur,
236 TFormOnBlurAsync,
237 TFormOnSubmit,
238 TFormOnSubmitAsync,
239 TFormOnDynamic,
240 TFormOnDynamicAsync,
241 TFormOnServer,
242 TSubmitMeta
243 >,
244) {
245 const formApi = (() => {
246 const api = new FormApi<
247 TParentData,
248 TFormOnMount,
249 TFormOnChange,
250 TFormOnChangeAsync,
251 TFormOnBlur,
252 TFormOnBlurAsync,
253 TFormOnSubmit,
254 TFormOnSubmitAsync,
255 TFormOnDynamic,
256 TFormOnDynamicAsync,
257 TFormOnServer,
258 TSubmitMeta
259 >(opts)
260β
261 const extendedApi: typeof api &
262 VueFormApi<
263 TParentData,
264 TFormOnMount,
265 TFormOnChange,
266 TFormOnChangeAsync,
267 TFormOnBlur,
268 TFormOnBlurAsync,
269 TFormOnSubmit,
270 TFormOnSubmitAsync,
271 TFormOnDynamic,
272 TFormOnDynamicAsync,
273 TFormOnServer,
274 TSubmitMeta
275 > = api as never
276 extendedApi.Field = defineComponent(
277 (props, context) => {
278 return () =>
279 h(
280 Field as never,
281 { ...props, ...context.attrs, form: api },
282 context.slots,
283 )
284 },
285 {
286 name: 'APIField',
287 inheritAttrs: false,
288 },
289 ) as never
290 extendedApi.useField = (props) => {
291 const field = useField({ ...props, form: api })
292 return field
293 }
294 extendedApi.useStore = (selector) => {
295 return useStore(api.store as never, selector as never) as never
296 }
297 extendedApi.Subscribe = defineComponent(
298 (props, context) => {
299 const allProps = { ...props, ...context.attrs }
300 const selector = allProps.selector ?? ((state: never) => state)
301 const data = useStore(api.store as never, selector as never)
302 return () => context.slots.default!(data.value)
303 },
304 {
305 name: 'Subscribe',
306 inheritAttrs: false,
307 },
308 ) as never
309β
310 return extendedApi
311 })()
312β
313 onMounted(formApi.mount)
314β
315 // formApi.useStore((state) => state.isSubmitting)
316 formApi.update(opts)
317β
318 return formApi
319}