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

tanstack-form-controller.ts

224 lines5.0 KB

1import { nothing } from 'lit'
2import { PartType, directive } from 'lit/directive.js'
3import { FieldApi, FormApi } from '@tanstack/form-core'
4import { AsyncDirective } from 'lit/async-directive.js'
5import type {
6 DeepKeys,
7 DeepValue,
8 FieldOptions,
9 FormOptions,
10 Validator,
11} from '@tanstack/form-core'
12import type { ElementPart, PartInfo } from 'lit/directive.js'
13import type { ReactiveController, ReactiveControllerHost } from 'lit'
14​
15type renderCallback<
16 TParentData,
17 TName extends DeepKeys<TParentData>,
18 TFieldValidator extends
19 | Validator<DeepValue<TParentData, TName>, unknown>
20 | undefined = undefined,
21 TFormValidator extends
22 | Validator<TParentData, unknown>
23 | undefined = undefined,
24 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
25> = (
26 fieldOptions: FieldApi<
27 TParentData,
28 TName,
29 TFieldValidator,
30 TFormValidator,
31 TData
32 >,
33) => unknown
34​
35type fieldDirectiveType<
36 TParentData,
37 TName extends DeepKeys<TParentData>,
38 TFieldValidator extends
39 | Validator<DeepValue<TParentData, TName>, unknown>
40 | undefined = undefined,
41 TFormValidator extends
42 | Validator<TParentData, unknown>
43 | undefined = undefined,
44 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
45> = (
46 form: FormApi<TParentData, TFormValidator>,
47 options: FieldOptions<
48 TParentData,
49 TName,
50 TFieldValidator,
51 TFormValidator,
52 TData
53 >,
54 render: renderCallback<
55 TParentData,
56 TName,
57 TFieldValidator,
58 TFormValidator,
59 TData
60 >,
61) => {
62 values: {
63 form: FormApi<TParentData, TFormValidator>
64 options: FieldOptions<
65 TParentData,
66 TName,
67 TFieldValidator,
68 TFormValidator,
69 TData
70 >
71 render: renderCallback<
72 TParentData,
73 TName,
74 TFieldValidator,
75 TFormValidator,
76 TData
77 >
78 }
80​
81export class TanStackFormController<
82 TParentData,
83 TFormValidator extends
84 | Validator<TParentData, unknown>
85 | undefined = undefined,
86> implements ReactiveController
88 #host: ReactiveControllerHost
89 #subscription?: () => void
90​
91 api: FormApi<TParentData, TFormValidator>
92​
93 constructor(
94 host: ReactiveControllerHost,
95 config?: FormOptions<TParentData, TFormValidator>,
96 ) {
97 ;(this.#host = host).addController(this)
98​
99 this.api = new FormApi<TParentData, TFormValidator>(config)
100 }
101​
102 hostConnected() {
103 this.#subscription = this.api.store.subscribe(() => {
104 this.#host.requestUpdate()
105 })
106 }
107​
108 hostDisconnected() {
109 this.#subscription?.()
110 }
111​
112 field<
113 TName extends DeepKeys<TParentData>,
114 TFieldValidator extends
115 | Validator<DeepValue<TParentData, TName>, unknown>
116 | undefined = undefined,
117 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
118 >(
119 fieldConfig: FieldOptions<
120 TParentData,
121 TName,
122 TFieldValidator,
123 TFormValidator,
124 TData
125 >,
126 render: renderCallback<
127 TParentData,
128 TName,
129 TFieldValidator,
130 TFormValidator,
131 TData
132 >,
133 ) {
134 return (
135 fieldDirective as unknown as fieldDirectiveType<
136 TParentData,
137 TName,
138 TFieldValidator,
139 TFormValidator,
140 TData
141 >
142 )(this.api, fieldConfig, render)
143 }
145​
146class FieldDirective<
147 TParentData,
148 TName extends DeepKeys<TParentData>,
149 TFieldValidator extends
150 | Validator<DeepValue<TParentData, TName>, unknown>
151 | undefined = undefined,
152 TFormValidator extends
153 | Validator<TParentData, unknown>
154 | undefined = undefined,
155 TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>,
156> extends AsyncDirective {
157 #registered = false
158 #field?: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>
159 #unmount?: () => void
160​
161 constructor(partInfo: PartInfo) {
162 super(partInfo)
163 if (partInfo.type !== PartType.CHILD) {
164 throw new Error(
165 'The `field` directive must be used in the `child` attribute',
166 )
167 }
168 }
169​
170 update(
171 _: ElementPart,
172 [form, fieldConfig, _render]: Parameters<this['render']>,
173 ) {
174 if (!this.#registered) {
175 if (!this.#field) {
176 const options = { ...fieldConfig, form }
177​
178 this.#field = new FieldApi(options)
179 this.#unmount = this.#field.mount()
180 }
181​
182 this.#registered = true
183 }
184​
185 return this.render(form, fieldConfig, _render)
186 }
187​
188 protected disconnected() {
189 super.disconnected()
190 this.#unmount?.()
191 }
192​
193 protected reconnected() {
194 super.reconnected()
195 if (this.#field) {
196 this.#unmount = this.#field.mount()
197 }
198 }
199​
200 render(
201 _form: FormApi<TParentData, TFormValidator>,
202 _fieldConfig: FieldOptions<
203 TParentData,
204 TName,
205 TFieldValidator,
206 TFormValidator,
207 TData
208 >,
209 _renderCallback: renderCallback<
210 TParentData,
211 TName,
212 TFieldValidator,
213 TFormValidator,
214 TData
215 >,
216 ) {
217 if (this.#field) {
218 return _renderCallback(this.#field)
219 }
220 return nothing
221 }
223​
224const fieldDirective = directive(FieldDirective)