Open History to see the last commit
1/// <reference lib="dom" />
2import { beforeEach, describe, expect, it } from 'vitest'
3import '@testing-library/jest-dom'
4import { userEvent } from '@testing-library/user-event'
5import { LitElement, html } from 'lit'
6import { TanStackFormController } from '../src/index.js'
7import { defineOnce, mount } from './utils'
8β
9interface Employee {
10 firstName: string
11 lastName: string
12 color?: '#FF0000' | '#00FF00' | '#0000FF'
13 employed: boolean
14 jobTitle: string
15}
16β
17const sampleData: Employee = {
18 firstName: 'Christian',
19 lastName: '',
20 employed: false,
21 jobTitle: '',
22}
23β
24class TestForm extends LitElement {
25 form = new TanStackFormController(this, {
26 defaultValues: sampleData,
27 })
28β
29 render() {
30 return html`
31 <form
32 id="form"
33 @submit=${(e: Event) => {
34 e.preventDefault()
35 }}
36 >
37 <h1>TanStack Form - Lit Demo</h1>
38β
39 ${this.form.field(
40 {
41 name: `firstName`,
42 validators: {
43 onChange: ({ value }) =>
44 value.length < 3 ? 'Not long enough' : undefined,
45 },
46 },
47 (field) => {
48 return html` <div>
49 <label>First Name</label>
50 <input
51 id="firstName"
52 type="text"
53 placeholder="First Name"
54 .value="${field.state.value}"
55 @blur="${() => field.handleBlur()}"
56 @input="${(e: Event) => {
57 const target = e.target as HTMLInputElement
58 field.handleChange(target.value)
59 }}"
60 />
61 </div>`
62 },
63 )}
64 ${this.form.field(
65 {
66 name: `lastName`,
67 validators: {
68 onChange: ({ value }) =>
69 value.length < 3 ? 'Not long enough' : undefined,
70 },
71 },
72 (field) => {
73 return html` <div>
74 <label>Last Name</label>
75 <input
76 id="lastName"
77 type="text"
78 placeholder="Last Name"
79 .value="${field.state.value}"
80 @blur="${() => field.handleBlur()}"
81 @input="${(e: Event) => {
82 const target = e.target as HTMLInputElement
83 field.handleChange(target.value)
84 }}"
85 />
86 </div>`
87 },
88 )}
89 ${this.form.field({ name: `color` }, (field) => {
90 return html` <div>
91 <label>Favorite Color</label>
92 <select
93 .value="${field.state.value}"
94 @blur="${() => field.handleBlur()}"
95 @input="${(e: Event) => {
96 const target = e.target as HTMLInputElement
97 field.handleChange(
98 target.value as '#FF0000' | '#00FF00' | '#0000FF',
99 )
100 }}"
101 >
102 <option value="#FF0000">Red</option>
103 <option value="#00FF00">Green</option>
104 <option value="#0000FF">Blue</option>
105 </select>
106 </div>`
107 })}
108 ${this.form.field({ name: `employed` }, (field) => {
109 return html`
110 <div>
111 <label>Employed?</label>
112 <input
113 @input="${() => field.handleChange(!field.state.value)}"
114 .checked="${field.state.value}"
115 @blur="${() => field.handleBlur()}"
116 id="employed"
117 .type=${'checkbox'}
118 />
119 </div>
120 ${field.state.value
121 ? this.form.field(
122 {
123 name: `jobTitle`,
124 validators: {
125 onChange: ({ value }) =>
126 value.length === 0 ? 'Needs to have a job here' : null,
127 },
128 },
129 (subField) => {
130 return html` <div>
131 <label>Job Title</label>
132 <input
133 type="text"
134 id="jobTitle"
135 placeholder="Job Title"
136 .value="${subField.state.value}"
137 @blur="${() => subField.handleBlur()}"
138 @input="${(e: Event) => {
139 const target = e.target as HTMLInputElement
140 subField.handleChange(target.value)
141 }}"
142 />
143 </div>`
144 },
145 )
146 : ''}
147 `
148 })}
149 </form>
150 <div>
151 <button
152 type="submit"
153 ?disabled=${this.form.api.state.isSubmitting}
154 >${this.form.api.state.isSubmitting ? html` Submitting` : 'Submit'}
155 </button>
156 <button
157 type="button"
158 id="reset"
159 @click=${() => {
160 this.form.api.reset()
161 }}
162 >
163 Reset
164 </button>
165 </div>
166 </form>
167 <pre>${JSON.stringify(this.form.api.state, null, 2)}</pre>
168 `
169 }
170}
171β
172defineOnce('test-form', TestForm)
173describe('Lit Tests', () => {
174 let element: TestForm
175 beforeEach(async () => {
176 element = await mount<TestForm>('test-form')
177 })
178β
179 it('should have initial values', async () => {
180 expect(
181 await element.shadowRoot!.querySelector<HTMLInputElement>('#firstName'),
182 ).toHaveValue(sampleData.firstName)
183 expect(
184 await element.shadowRoot!.querySelector<HTMLInputElement>('#lastName'),
185 ).toHaveValue('')
186 const form = element.form!
187 expect(form.api.getFieldValue('firstName')).toBe(sampleData.firstName)
188 expect(form.api.getFieldMeta('firstName')?.isTouched).toBeFalsy()
189 expect(form.api.getFieldValue('lastName')).toBe('')
190 expect(form.api.getFieldMeta('lastName')?.isTouched).toBeFalsy()
191 })
192 it('should mirror user input', async () => {
193 const lastName =
194 await element.shadowRoot!.querySelector<HTMLInputElement>('#lastName')!
195 const lastNameValue = 'Jobs'
196 await userEvent.type(lastName, lastNameValue)
197β
198 const form = element.form!
199 expect(form.api.getFieldValue('lastName')).toBe(lastNameValue)
200 expect(form.api.getFieldMeta('lastName')?.isTouched).toBeTruthy()
201 })
202 it('Reset form to initial value', async () => {
203 const firstName =
204 await element.shadowRoot!.querySelector<HTMLInputElement>('#firstName')!
205 await userEvent.type(firstName, '-Joseph')
206β
207 expect(firstName).toHaveValue('Christian-Joseph')
208β
209 const form = element.form
210 await element
211 .shadowRoot!.querySelector<HTMLButtonElement>('#reset')
212 ?.click()
213 expect(form.api.getFieldValue('firstName')).toBe(sampleData.firstName)
214 })
215β
216 it('should display validation', async () => {
217 const lastName =
218 await element.shadowRoot!.querySelector<HTMLInputElement>('#lastName')!
219 const lastNameValue = 'Jo'
220 await userEvent.type(lastName, lastNameValue)
221 expect(lastName).toHaveValue('Jo')
222 const form = element.form
223 expect(form.api.getFieldMeta('lastName')?.errors[0]).toBe('Not long enough')
224β
225 await userEvent.type(lastName, lastNameValue)
226β
227 expect(await lastName.getAttribute('error-text')).toBeFalsy()
228 expect(form.api.getFieldValue('lastName')).toBe('JoJo')
229 expect(form.api.getFieldMeta('lastName')?.isTouched).toBeTruthy()
230 expect(form.api.getFieldMeta('lastName')?.errors.length).toBeFalsy()
231 })
232})