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

withFields.public.ts

92 lines3.1 KB

1import { defineFieldGroupRuntime } from './withFields.lib'
2import type {
3 FieldGroupFieldBindings,
4 FieldGroupFieldBindingsProps,
5 FieldGroupFieldData,
6 FieldGroupFields,
7 FieldGroupFieldsPropName,
8 FieldGroupHelper,
9 FormApi,
10} from '@tanstack/form-core'
11import type { FunctionComponent } from 'preact/compat'
12import type { CrossVersionPreactNode } from '../preactTypes.public'
13import type { PreactTanStackFormComponents } from '../PreactForm/Components.public'
14import type { FieldGroupApi } from './FieldGroupApi.public'
15​
16declare const fieldGroupFieldsSymbol: unique symbol
17​
18export type FieldGroupFieldsOf<TFieldGroup> = TFieldGroup extends {
19 readonly [fieldGroupFieldsSymbol]: infer TFields extends FieldGroupFields
21 ? TFields
22 : never
23​
24export type PreactFieldGroup<
25 TFields extends FieldGroupFields,
26 TFieldComponents extends Record<string, FunctionComponent<any>> = Record<
27 never,
28 never
29 >,
30> = FieldGroupApi<FieldGroupFieldData<TFields>, TFieldComponents> & {
31 readonly [fieldGroupFieldsSymbol]: TFields
33​
34export type FieldGroupFieldComponentsOf<TFieldGroup> =
35 TFieldGroup extends PreactFieldGroup<any, infer TFieldComponents>
36 ? TFieldComponents
37 : never
38​
39export type FieldGroupForm<
40 TFieldComponents extends Record<string, FunctionComponent<any>> = Record<
41 never,
42 never
43 >,
44 TFormData = any,
45> = FormApi<TFormData, any> &
46 PreactTanStackFormComponents<TFormData, any, TFieldComponents>
47​
48export type FieldGroupFieldBindingsOf<TFieldGroup, TFormData> =
49 FieldGroupFieldsOf<TFieldGroup> extends FieldGroupFields
50 ? FieldGroupFieldBindings<FieldGroupFieldsOf<TFieldGroup>, TFormData>
51 : never
52​
53export type FieldGroupWithFieldsFn<
54 TFieldGroup extends PreactFieldGroup<any, any>,
55> = <
56 TProps extends object,
57 TFieldsPropName extends FieldGroupFieldsPropName<TProps, TFieldGroup>,
58>(
59 Component: (props: TProps) => CrossVersionPreactNode,
60 fieldsPropName: TFieldsPropName,
61) => <TFormData>(
62 props: Omit<TProps, TFieldsPropName | 'form'> & {
63 form: FieldGroupForm<FieldGroupFieldComponentsOf<TFieldGroup>, TFormData>
64 } & FieldGroupFieldBindingsProps<
65 FieldGroupFieldsOf<TFieldGroup>,
66 TFormData,
67 TFieldsPropName
68 >,
69) => CrossVersionPreactNode
70​
71export interface FieldGroupDefinition<
72 TFields extends FieldGroupFields,
73 TFieldComponents extends Record<string, FunctionComponent<any>>,
74> {
75 /** The virtual field-group API injected into the bound component. */
76 fields: PreactFieldGroup<TFields, TFieldComponents>
77 /** Binds a component's virtual field API to concrete paths in a form. */
78 bindComponent: FieldGroupWithFieldsFn<
79 PreactFieldGroup<TFields, TFieldComponents>
80 >
82​
83/** Signature shared by `defineFieldGroup` and app-form field-group definers. */
84export type DefineFieldGroupFn<
85 TFieldComponents extends Record<string, FunctionComponent<any>>,
86> = <const TFields extends FieldGroupFields>(
87 defineFn: (helper: FieldGroupHelper) => TFields,
88) => FieldGroupDefinition<TFields, TFieldComponents>
89​
90/** Defines a reusable group of virtual fields. */
91export const defineFieldGroup: DefineFieldGroupFn<Record<never, never>> =
92 defineFieldGroupRuntime as never