Open History to see the last commit
1import { FieldApi, type Validator } from '@tanstack/form-core'
2import {
3 createComponent,
4 createComputed,
5 createMemo,
6 createSignal,
7 onCleanup,
8 onMount,
9} from 'solid-js'
10import { formContext, useFormContext } from './formContext'
11β
12import type { DeepKeys, DeepValue, Narrow } from '@tanstack/form-core'
13import type { JSXElement } from 'solid-js'
14import type { CreateFieldOptions } from './types'
15β
16declare module '@tanstack/form-core' {
17 // eslint-disable-next-line no-shadow
18 interface FieldApi<
19 TParentData,
20 TName extends DeepKeys<TParentData>,
21 TFieldValidator extends
22 | Validator<DeepValue<TParentData, TName>, unknown>
23 | undefined = undefined,
24 TFormValidator extends
25 | Validator<TParentData, unknown>
26 | undefined = undefined,
27 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
28 > {
29 Field: FieldComponent<TParentData, TFormValidator>
30 }
31}
32β
33export type CreateField<TParentData> = <
34 TName extends DeepKeys<TParentData>,
35 TFieldValidator extends
36 | Validator<DeepValue<TParentData, TName>, unknown>
37 | undefined = undefined,
38 TFormValidator extends
39 | Validator<TParentData, unknown>
40 | undefined = undefined,
41>(
42 opts: () => { name: Narrow<TName> } & CreateFieldOptions<
43 TParentData,
44 TName,
45 TFieldValidator,
46 TFormValidator
47 >,
48) => () => FieldApi<
49 TParentData,
50 TName,
51 TFieldValidator,
52 TFormValidator,
53 DeepValue<TParentData, TName>
54>
55β
56// ugly way to trick solid into triggering updates for changes on the fieldApi
57function makeFieldReactive<FieldApiT extends FieldApi<any, any, any, any>>(
58 fieldApi: FieldApiT,
59): () => FieldApiT {
60 const [flag, setFlag] = createSignal(false)
61 const fieldApiMemo = createMemo(() => [flag(), fieldApi] as const)
62 const unsubscribeStore = fieldApi.store.subscribe(() => setFlag((f) => !f))
63 onCleanup(unsubscribeStore)
64 return () => fieldApiMemo()[1]
65}
66β
67export function createField<
68 TParentData,
69 TName extends DeepKeys<TParentData>,
70 TFieldValidator extends
71 | Validator<DeepValue<TParentData, TName>, unknown>
72 | undefined = undefined,
73 TFormValidator extends
74 | Validator<TParentData, unknown>
75 | undefined = undefined,
76>(
77 opts: () => CreateFieldOptions<
78 TParentData,
79 TName,
80 TFieldValidator,
81 TFormValidator
82 >,
83): () => FieldApi<TParentData, TName, TFieldValidator, TFormValidator> {
84 // Get the form API either manually or from context
85 const { formApi, parentFieldName } = useFormContext()
86β
87 const options = opts()
88 const name = (
89 typeof options.index === 'number'
90 ? [parentFieldName, options.index, options.name]
91 : [parentFieldName, options.name]
92 )
93 .filter((d) => d !== undefined)
94 .join('.')
95β
96 const fieldApi = new FieldApi({
97 ...options,
98 form: formApi,
99 name: name as typeof options.name as never,
100 })
101 fieldApi.Field = Field as never
102β
103 /**
104 * fieldApi.update should not have any side effects. Think of it like a `useRef`
105 * that we need to keep updated every render with the most up-to-date information.
106 *
107 * createComputed to make sure this effect runs before render effects
108 */
109 createComputed(() => fieldApi.update({ ...opts(), form: formApi } as never))
110β
111 // Instantiates field meta and removes it when unrendered
112 onMount(() => onCleanup(fieldApi.mount()))
113β
114 return makeFieldReactive(fieldApi) as never
115}
116β
117type FieldComponentProps<
118 TParentData,
119 TName extends DeepKeys<TParentData>,
120 TFieldValidator extends
121 | Validator<DeepValue<TParentData, TName>, unknown>
122 | undefined = undefined,
123 TFormValidator extends
124 | Validator<TParentData, unknown>
125 | undefined = undefined,
126 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
127> = {
128 children: (
129 fieldApi: () => FieldApi<
130 TParentData,
131 TName,
132 TFieldValidator,
133 TFormValidator,
134 TData
135 >,
136 ) => JSXElement
137} & (TParentData extends any[]
138 ? {
139 name?: TName
140 index: number
141 }
142 : {
143 name: TName
144 index?: never
145 }) &
146 Omit<
147 CreateFieldOptions<TParentData, TName, TFieldValidator, TFormValidator>,
148 'name' | 'index'
149 >
150β
151export type FieldComponent<
152 TParentData,
153 TFormValidator extends
154 | Validator<TParentData, unknown>
155 | undefined = undefined,
156> = <
157 TName extends DeepKeys<TParentData>,
158 TFieldValidator extends
159 | Validator<DeepValue<TParentData, TName>, unknown>
160 | undefined = undefined,
161 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
162>({
163 children,
164 ...fieldOptions
165}: FieldComponentProps<
166 TParentData,
167 TName,
168 TFieldValidator,
169 TFormValidator,
170 TData
171>) => JSXElement
172β
173export function Field<
174 TParentData,
175 TName extends DeepKeys<TParentData>,
176 TFieldValidator extends
177 | Validator<DeepValue<TParentData, TName>, unknown>
178 | undefined = undefined,
179 TFormValidator extends
180 | Validator<TParentData, unknown>
181 | undefined = undefined,
182>(
183 props: {
184 children: (
185 fieldApi: () => FieldApi<
186 TParentData,
187 TName,
188 TFieldValidator,
189 TFormValidator
190 >,
191 ) => JSXElement
192 } & CreateFieldOptions<TParentData, TName, TFieldValidator, TFormValidator>,
193) {
194 const fieldApi = createField<
195 TParentData,
196 TName,
197 TFieldValidator,
198 TFormValidator
199 >(() => {
200 const { children, ...fieldOptions } = props
201 return fieldOptions
202 })
203β
204 return (
205 <formContext.Provider
206 value={{
207 formApi: fieldApi().form as never,
208 parentFieldName: String(fieldApi().name),
209 }}
210 >
211 {/* createComponent to make sure the signals in the children component are not tracked */}
212 {createComponent(() => props.children(fieldApi), {})}
213 </formContext.Provider>
214 )
215}