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

Components.public.ts

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