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

tanstack-field.spec.ts

259 lines7.7 KB

1import { ChangeDetectionStrategy, Component } from '@angular/core'
2import { render } from 'vitest-browser-angular'
3import { userEvent } from 'vitest/browser'
4import { describe, expect, it, vi } from 'vitest'
5import {
6 TanStackArrayField,
7 TanStackField,
8 injectForm,
9 injectSelector,
10} from '../src/index'
11import { sleep } from './utils'
12import type { FieldValidatorFn } from '@tanstack/form-core'
13​
14describe('TanStackField', () => {
15 it('reads and updates a form-level default value', async () => {
16 @Component({
17 standalone: true,
18 changeDetection: ChangeDetectionStrategy.OnPush,
19 imports: [TanStackField],
20 template: `
21 <ng-container [tanstackField]="form" name="firstName" #field="field">
22 <input
23 aria-label="First name"
24 [value]="field.api.value"
25 (blur)="field.api.handleBlur()"
26 (input)="field.api.handleChange($any($event).target.value)"
27 />
28 <output data-testid="value">{{ field.api.value }}</output>
29 </ng-container>
30 <button
31 type="button"
32 (click)="form.reset({ firstName: 'Katherine', lastName: 'Johnson' })"
33 >
34 Reset
35 </button>
36 `,
37 })
38 class TestComponent {
39 form = injectForm({
40 defaultValues: { firstName: 'Ada', lastName: 'Lovelace' },
41 })
42 }
43​
44 const screen = await render(TestComponent)
45 const input = screen.getByLabelText('First name')
46​
47 expect(input).toHaveValue('Ada')
48 await input.clear()
49 await userEvent.type(input, 'Grace')
50 expect(screen.getByTestId('value')).toHaveTextContent('Grace')
51 await screen.getByRole('button', { name: 'Reset' }).click()
52 expect(input).toHaveValue('Katherine')
53 })
54​
55 it('supports ordered change and blur validators with v2 issues', async () => {
56 type Person = { firstName: string }
57 const changeMessage = 'Name is too short'
58 const blurMessage = 'Name must not be Ada'
59​
60 @Component({
61 standalone: true,
62 changeDetection: ChangeDetectionStrategy.OnPush,
63 imports: [TanStackField],
64 template: `
65 <ng-container
66 [tanstackField]="form"
67 name="firstName"
68 [validators]="validators"
69 [errorVisibility]="showErrors"
70 #field="field"
71 >
72 <input
73 aria-label="First name"
74 [value]="field.api.value"
75 (blur)="field.api.handleBlur()"
76 (input)="field.api.handleChange($any($event).target.value)"
77 />
78 @for (error of field.api.errors; track error) {
79 <p role="alert">{{ error.message }}</p>
80 }
81 </ng-container>
82 <button type="button">Next</button>
83 `,
84 })
85 class TestComponent {
86 showErrors = () => true
87 validators = [
88 {
89 triggers: ['change'] as const,
90 run: (({ value }) =>
91 value.length < 3
92 ? { message: changeMessage }
93 : undefined) satisfies FieldValidatorFn<
94 Person,
95 'firstName',
96 string
97 >,
98 },
99 {
100 triggers: ['blur'] as const,
101 run: (({ value }) =>
102 value === 'Ada'
103 ? { message: blurMessage }
104 : undefined) satisfies FieldValidatorFn<
105 Person,
106 'firstName',
107 string
108 >,
109 },
110 ]
111 form = injectForm({ defaultValues: { firstName: 'Ada' } as Person })
112 }
113​
114 const screen = await render(TestComponent)
115 const input = screen.getByLabelText('First name')
116​
117 await input.click()
118 await userEvent.tab()
119 await expect.element(screen.getByText(blurMessage)).toBeInTheDocument()
120 await input.click()
121 await input.clear()
122 await userEvent.type(input, 'A')
123 expect(screen.getByText(changeMessage)).toBeInTheDocument()
124 })
125​
126 it('supports async validators and triggerDebounceMs', async () => {
127 @Component({
128 standalone: true,
129 imports: [TanStackField],
130 template: `
131 <ng-container
132 [tanstackField]="form"
133 name="name"
134 [validators]="validators"
135 [errorVisibility]="showErrors"
136 #field="field"
137 >
138 <input
139 aria-label="Name"
140 [value]="field.api.value"
141 (input)="field.api.handleChange($any($event).target.value)"
142 />
143 @for (error of field.api.errors; track error) {
144 <p role="alert">{{ error.message }}</p>
145 }
146 </ng-container>
147 `,
148 })
149 class TestComponent {
150 showErrors = () => true
151 validators = [
152 {
153 triggers: ['change'] as const,
154 triggerDebounceMs: 1,
155 run: async () => {
156 await sleep(5)
157 return { message: 'Async issue' }
158 },
159 },
160 ]
161 form = injectForm({ defaultValues: { name: '' } })
162 }
163​
164 const screen = await render(TestComponent)
165 await userEvent.type(screen.getByLabelText('Name'), 'x')
166 await expect
167 .element(screen.getByRole('alert'))
168 .toHaveTextContent('Async issue')
169 })
170​
171 it('supports ordered v2 field listeners', async () => {
172 const listener = vi.fn()
173​
174 @Component({
175 standalone: true,
176 imports: [TanStackField],
177 template: `
178 <ng-container
179 [tanstackField]="form"
180 name="name"
181 [listeners]="listeners"
182 #field="field"
183 >
184 <input
185 aria-label="Name"
186 [value]="field.api.value"
187 (input)="field.api.handleChange($any($event).target.value)"
188 />
189 </ng-container>
190 `,
191 })
192 class TestComponent {
193 listeners = [{ triggers: ['change'] as const, run: listener }]
194 form = injectForm({ defaultValues: { name: '' } })
195 }
196​
197 const screen = await render(TestComponent)
198 await userEvent.type(screen.getByLabelText('Name'), 'A')
199 expect(listener).toHaveBeenCalled()
200 })
201})
202​
203describe('TanStackArrayField', () => {
204 it('rerenders for structural array changes', async () => {
205 @Component({
206 standalone: true,
207 changeDetection: ChangeDetectionStrategy.OnPush,
208 imports: [TanStackArrayField],
209 template: `
210 <ng-container
211 [tanstackArrayField]="form"
212 name="items"
213 #field="arrayField"
214 >
215 <output data-testid="items">{{ field.api.value.join(',') }}</output>
216 <button type="button" (click)="form.swapFieldValues('items', 0, 1)">
217 Swap
218 </button>
219 </ng-container>
220 `,
221 })
222 class TestComponent {
223 form = injectForm({ defaultValues: { items: ['one', 'two'] } })
224 }
225​
226 const screen = await render(TestComponent)
227 expect(screen.getByTestId('items')).toHaveTextContent('one,two')
228 await screen.getByRole('button', { name: 'Swap' }).click()
229 expect(screen.getByTestId('items')).toHaveTextContent('two,one')
230 })
231})
232​
233describe('injectSelector', () => {
234 it('exposes selected form state as an Angular signal', async () => {
235 @Component({
236 standalone: true,
237 imports: [TanStackField],
238 template: `
239 <ng-container [tanstackField]="form" name="name" #field="field">
240 <input
241 aria-label="Name"
242 [value]="field.api.value"
243 (input)="field.api.handleChange($any($event).target.value)"
244 />
245 </ng-container>
246 <output data-testid="name">{{ name() }}</output>
247 `,
248 })
249 class TestComponent {
250 form = injectForm({ defaultValues: { name: 'Ada' } })
251 name = injectSelector(this.form, (state) => state.values.name)
252 }
253​
254 const screen = await render(TestComponent)
255 await screen.getByLabelText('Name').clear()
256 await userEvent.type(screen.getByLabelText('Name'), 'Grace')
257 expect(screen.getByTestId('name')).toHaveTextContent('Grace')
258 })
259})