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

Components.public.ts

381 lines9.3 KB

1import type {
2 DeepKeys,
3 DeepKeysWhereValueIncludes,
4 DeepValue,
5 FieldApi,
6 FieldApiOptions,
7 FieldValidators,
8 FormErrorTypes,
9 FormGroupApi,
10 FormGroupOptions,
11 FormGroupState,
12 FormGroupValidators,
13 FormState,
14 ToFieldError,
15 ToFormGroupErrorTypes,
16} from '@tanstack/form-core'
17import type {
18 FunctionComponent,
19 LazyExoticComponent,
20 MemoExoticComponent,
21 ReactNode,
22} from 'react'
23import type { ReactComponentTree } from '../AppForm/componentMap.public'
24​
25type ExactFieldBrand<out TValue> = {
26 readonly __tanstackFieldExactType: TValue
28​
29type AcceptsFieldBrand<out TAcceptedValue> = {
30 readonly __tanstackFieldAcceptsType: TAcceptedValue
32​
33type CompatibleFieldKey<TKey, TComponent, TTargetValue> = [TComponent] extends [
34 ExactFieldBrand<infer TExact>,
36 ? [TExact] extends [TTargetValue]
37 ? [TTargetValue] extends [TExact]
38 ? TKey
39 : never
40 : never
41 : [TComponent] extends [AcceptsFieldBrand<infer TLoose>]
42 ? [TTargetValue] extends [TLoose]
43 ? TKey
44 : never
45 : TKey
46​
47type UnwrapComponent<TComponent> =
48 TComponent extends LazyExoticComponent<infer TInner>
49 ? UnwrapComponent<TInner>
50 : TComponent extends MemoExoticComponent<infer TInner>
51 ? UnwrapComponent<TInner>
52 : TComponent
53​
54type FilteredFieldComponents<
55 in out TFieldComponents extends ReactComponentTree,
56 in out TTargetValue,
57> = {
58 [
59 K in keyof TFieldComponents as TFieldComponents[K] extends FunctionComponent<any>
60 ? CompatibleFieldKey<
61 K,
62 UnwrapComponent<TFieldComponents[K]>,
63 TTargetValue
64 >
65 : K
66 ]: TFieldComponents[K] extends infer TComp extends FunctionComponent<any>
67 ? TComp
68 : TFieldComponents[K] extends ReactComponentTree
69 ? FieldComponentsMatchingType<TFieldComponents[K], TTargetValue>
70 : never
72​
73type FieldComponentsMatchingType<
74 TFieldComponents extends ReactComponentTree,
75 TTargetValue,
76> = unknown extends TTargetValue
77 ? TFieldComponents
78 : string extends keyof TFieldComponents
79 ? TFieldComponents
80 : FilteredFieldComponents<TFieldComponents, TTargetValue>
81​
82export type ReactFieldApi<
83 TFieldName,
84 TFieldValue,
85 TFieldError,
86 TFormData,
87 TFormErrorTypes extends FormErrorTypes,
88 TFieldComponents extends ReactComponentTree,
89> = FieldApi<TFieldName, TFieldValue, TFieldError, TFormData, TFormErrorTypes> &
90 FieldComponentsMatchingType<TFieldComponents, TFieldValue>
91​
92/**
93 * Subscribe to `form.atom` (full form state). The selector receives the full
94 * {@link FormState}.
95 */
96interface ReactSubscribeProps<in out TSourceData, in out TSelected> {
97 selector: (state: TSourceData) => TSelected
98 when?: (selected: NoInfer<TSelected>) => boolean
99 children: ((state: NoInfer<TSelected>) => ReactNode) | ReactNode
101​
102export type ReactFormSubscribeProps<
103 TFormData,
104 TFormErrorTypes extends FormErrorTypes,
105 TSelected,
106> = ReactSubscribeProps<FormState<TFormData, TFormErrorTypes>, TSelected>
107​
108export type ReactFormSubscribeComponent<
109 in out TFormData,
110 in out TFormErrorTypes extends FormErrorTypes,
111> = <const TSelected>(
112 props: ReactFormSubscribeProps<TFormData, TFormErrorTypes, TSelected>,
113) => ReactNode
114​
115export interface ReactFormFieldProps<
116 in out TFieldData,
117 in out TFieldName,
118 in out TFieldValue,
119 in out TFieldValidators extends FieldValidators<
120 TFieldData,
121 TFieldName,
122 TFieldValue
123 >,
124 in out TGroupFieldError,
125 in out TFormData,
126 in out TFormErrorTypes extends FormErrorTypes,
127 in out TFieldComponents extends ReactComponentTree,
128> extends FieldApiOptions<
129 TFieldData,
130 TFieldName,
131 TFieldValue,
132 TFieldValidators,
133 TGroupFieldError,
134 TFormData,
135 TFormErrorTypes
136> {
137 children: (
138 fieldApi: ReactFieldApi<
139 TFieldName,
140 TFieldValue,
141 ToFieldError<
142 NoInfer<TFieldValidators>,
143 TGroupFieldError,
144 TFormErrorTypes
145 >,
146 TFormData,
147 TFormErrorTypes,
148 TFieldComponents
149 >,
150 ) => ReactNode
152​
153export type ReactFormFieldComponent<
154 in out TFormData,
155 in out TFormErrorTypes extends FormErrorTypes,
156 in out TFieldComponents extends ReactComponentTree,
157> = {
158 <
159 TFieldName extends DeepKeys<TFormData>,
160 const TFieldValidators extends FieldValidators<
161 TFormData,
162 TFieldName,
163 DeepValue<TFormData, TFieldName>
164 >,
165 >(
166 props: ReactFormFieldProps<
167 TFormData,
168 TFieldName,
169 DeepValue<TFormData, TFieldName>,
170 TFieldValidators,
171 never,
172 TFormData,
173 TFormErrorTypes,
174 TFieldComponents
175 >,
176 ): ReactNode
178​
179export type ReactFormArrayFieldComponent<
180 in out TFormData,
181 in out TFormErrorTypes extends FormErrorTypes,
182 in out TFieldComponents extends ReactComponentTree,
183> = {
184 <
185 TFieldName extends DeepKeysWhereValueIncludes<TFormData, Array<any>>,
186 const TFieldValidators extends FieldValidators<
187 TFormData,
188 TFieldName,
189 DeepValue<TFormData, TFieldName>
190 >,
191 >(
192 props: ReactFormFieldProps<
193 TFormData,
194 TFieldName,
195 DeepValue<TFormData, TFieldName>,
196 TFieldValidators,
197 never,
198 TFormData,
199 TFormErrorTypes,
200 TFieldComponents
201 >,
202 ): ReactNode
204​
205export type ReactFormGroupSubscribeProps<
206 TGroupValue,
207 TGroupErrorTypes extends FormErrorTypes,
208 TSelected,
209> = ReactSubscribeProps<
210 FormGroupState<TGroupValue, TGroupErrorTypes>,
211 TSelected
213​
214export type ReactFormGroupSubscribeComponent<
215 in out TGroupValue,
216 in out TGroupErrorTypes extends FormErrorTypes,
217> = <const TSelected>(
218 props: ReactFormGroupSubscribeProps<TGroupValue, TGroupErrorTypes, TSelected>,
219) => ReactNode
220​
221export interface ReactFormGroupFieldComponent<
222 in out TFormData,
223 in out TGroupValue,
224 in out TGroupErrorTypes extends FormErrorTypes,
225 in out TFormErrorTypes extends FormErrorTypes,
226 in out TFieldComponents extends ReactComponentTree,
227> {
228 <
229 TFieldName extends DeepKeys<TGroupValue>,
230 const TFieldValidators extends FieldValidators<
231 TGroupValue,
232 TFieldName,
233 DeepValue<TGroupValue, TFieldName>
234 >,
235 >(
236 props: ReactFormFieldProps<
237 TGroupValue,
238 TFieldName,
239 DeepValue<TGroupValue, TFieldName>,
240 TFieldValidators,
241 TGroupErrorTypes['fieldError'],
242 TFormData,
243 TFormErrorTypes,
244 TFieldComponents
245 >,
246 ): ReactNode
248​
249export type ReactFormGroupArrayFieldComponent<
250 in out TFormData,
251 in out TGroupValue,
252 in out TGroupErrorTypes extends FormErrorTypes,
253 in out TFormErrorTypes extends FormErrorTypes,
254 in out TFieldComponents extends ReactComponentTree,
255> = {
256 <
257 TFieldName extends DeepKeysWhereValueIncludes<TGroupValue, Array<any>>,
258 const TFieldValidators extends FieldValidators<
259 TGroupValue,
260 TFieldName,
261 DeepValue<TGroupValue, TFieldName>
262 >,
263 >(
264 props: ReactFormFieldProps<
265 TGroupValue,
266 TFieldName,
267 DeepValue<TGroupValue, TFieldName>,
268 TFieldValidators,
269 TGroupErrorTypes['fieldError'],
270 TFormData,
271 TFormErrorTypes,
272 TFieldComponents
273 >,
274 ): ReactNode
276​
277export interface ReactFormGroupApi<
278 in out TFormData,
279 in out TGroupName,
280 in out TGroupValue,
281 in out TGroupErrorTypes extends FormErrorTypes,
282 in out TFormErrorTypes extends FormErrorTypes,
283 in out TFieldComponents extends ReactComponentTree,
284> extends FormGroupApi<
285 TFormData,
286 TGroupName,
287 TGroupValue,
288 TGroupErrorTypes,
289 TFormErrorTypes
290> {
291 Field: ReactFormGroupFieldComponent<
292 TFormData,
293 TGroupValue,
294 TGroupErrorTypes,
295 TFormErrorTypes,
296 TFieldComponents
297 >
298 ArrayField: ReactFormGroupArrayFieldComponent<
299 TFormData,
300 TGroupValue,
301 TGroupErrorTypes,
302 TFormErrorTypes,
303 TFieldComponents
304 >
305 Subscribe: ReactFormGroupSubscribeComponent<TGroupValue, TGroupErrorTypes>
307​
308export interface ReactFormGroupProps<
309 in out TFormData,
310 in out TGroupName,
311 in out TGroupValue,
312 in out TGroupValidators extends FormGroupValidators<TGroupValue>,
313 in out TFormErrorTypes extends FormErrorTypes,
314 in out TFieldComponents extends ReactComponentTree,
315> extends Omit<
316 FormGroupOptions<
317 TFormData,
318 TGroupName,
319 TGroupValue,
320 TGroupValidators,
321 TFormErrorTypes
322 >,
323 'form'
324> {
325 children: (
326 groupApi: ReactFormGroupApi<
327 TFormData,
328 TGroupName,
329 TGroupValue,
330 ToFormGroupErrorTypes<NoInfer<TGroupValidators>>,
331 TFormErrorTypes,
332 TFieldComponents
333 >,
334 ) => ReactNode
336​
337export interface ReactFormGroupComponent<
338 in out TFormData,
339 in out TFormErrorTypes extends FormErrorTypes,
340 in out TFieldComponents extends ReactComponentTree,
341> {
342 <
343 TGroupName extends DeepKeys<TFormData>,
344 TGroupValue extends DeepValue<TFormData, TGroupName>,
345 const TGroupValidators extends FormGroupValidators<TGroupValue>,
346 >(
347 props: ReactFormGroupProps<
348 TFormData,
349 TGroupName,
350 TGroupValue,
351 TGroupValidators,
352 TFormErrorTypes,
353 TFieldComponents
354 >,
355 ): ReactNode
357​
358export interface ReactTanStackFormComponents<
359 in out TFormData,
360 in out TFormErrorTypes extends FormErrorTypes,
361 in out TFieldComponents extends ReactComponentTree,
362> {
363 /**
364 * TODO docs
365 */
366 Field: ReactFormFieldComponent<TFormData, TFormErrorTypes, TFieldComponents>
367​
368 ArrayField: ReactFormArrayFieldComponent<
369 TFormData,
370 TFormErrorTypes,
371 TFieldComponents
372 >
373​
374 Subscribe: ReactFormSubscribeComponent<TFormData, TFormErrorTypes>
375​
376 FormGroup: ReactFormGroupComponent<
377 TFormData,
378 TFormErrorTypes,
379 TFieldComponents
380 >