Open History to see the last commit
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 { Component, JSX } from 'solid-js'
12import type { SolidTanStackFormComponents } from '../Components.public'
13import type { FieldGroupApi } from './FieldGroupApi.public'
14β
15declare const fieldGroupFieldsSymbol: unique symbol
16export type FieldGroupFieldsOf<TFieldGroup> = TFieldGroup extends {
17 readonly [fieldGroupFieldsSymbol]: infer TFields extends FieldGroupFields
18}
19 ? TFields
20 : never
21β
22export type SolidFieldGroup<
23 TFields extends FieldGroupFields,
24 TFieldComponents extends Record<string, Component<any>> = Record<
25 never,
26 never
27 >,
28> = FieldGroupApi<FieldGroupFieldData<TFields>, TFieldComponents> & {
29 readonly [fieldGroupFieldsSymbol]: TFields
30}
31export type FieldGroupFieldComponentsOf<TFieldGroup> =
32 TFieldGroup extends SolidFieldGroup<any, infer TFieldComponents>
33 ? TFieldComponents
34 : never
35export type FieldGroupForm<
36 TFieldComponents extends Record<string, Component<any>> = Record<
37 never,
38 never
39 >,
40 TFormData = any,
41> = FormApi<TFormData, any> &
42 SolidTanStackFormComponents<TFormData, any, TFieldComponents>
43β
44export type FieldGroupFieldBindingsOf<TFieldGroup, TFormData> =
45 FieldGroupFieldsOf<TFieldGroup> extends FieldGroupFields
46 ? FieldGroupFieldBindings<FieldGroupFieldsOf<TFieldGroup>, TFormData>
47 : never
48β
49export type FieldGroupWithFieldsFn<
50 TFieldGroup extends SolidFieldGroup<any, any>,
51> = <
52 TProps extends object,
53 TFieldsPropName extends FieldGroupFieldsPropName<TProps, TFieldGroup>,
54>(
55 Component: (props: TProps) => JSX.Element,
56 fieldsPropName: TFieldsPropName,
57) => <TFormData>(
58 props: Omit<TProps, TFieldsPropName | 'form'> & {
59 form: FieldGroupForm<FieldGroupFieldComponentsOf<TFieldGroup>, TFormData>
60 } & FieldGroupFieldBindingsProps<
61 FieldGroupFieldsOf<TFieldGroup>,
62 TFormData,
63 TFieldsPropName
64 >,
65) => JSX.Element
66β
67export interface FieldGroupDefinition<
68 TFields extends FieldGroupFields,
69 TFieldComponents extends Record<string, Component<any>>,
70> {
71 /** The virtual field-group API injected into the bound component. */
72 fields: SolidFieldGroup<TFields, TFieldComponents>
73 /** Binds a component's virtual field API to concrete paths in a form. */
74 bindComponent: FieldGroupWithFieldsFn<
75 SolidFieldGroup<TFields, TFieldComponents>
76 >
77}
78β
79/** Signature shared by `defineFieldGroup` and app-form field-group definers. */
80export type DefineFieldGroupFn<
81 TFieldComponents extends Record<string, Component<any>>,
82> = <const TFields extends FieldGroupFields>(
83 defineFn: (helper: FieldGroupHelper) => TFields,
84) => FieldGroupDefinition<TFields, TFieldComponents>
85β
86/** Defines a reusable group of virtual fields. */
87export const defineFieldGroup: DefineFieldGroupFn<Record<never, never>> =
88 defineFieldGroupRuntime as never