Open History to see the last commit
1import { TanStackDevtools } from '@tanstack/react-devtools'
2import { useForm } from '@tanstack/react-form'
3import { formDevtoolsPlugin } from '@tanstack/react-form-devtools'
4import ReactDOM from 'react-dom/client'
5import type { AnyFieldApi } from '@tanstack/react-form'
6import './index.css'
7β
8interface FieldInfoProps {
9 field: AnyFieldApi
10}
11function FieldError({ field }: FieldInfoProps) {
12 return (
13 <small role={field.meta.isInvalid ? 'alert' : undefined} aria-live="polite">
14 {field.errors.map((e) => e.message).join('\n')}
15 </small>
16 )
17}
18β
19function App() {
20 const form = useForm({
21 defaultValues: {
22 firstName: '',
23 lastName: '',
24 },
25 onSubmit: ({ value, createValidationError }) => {
26 // Do something with form data
27 console.log(value)
28β
29 // If your endpoint returned validation errors, pass them on
30 return createValidationError({
31 fields: {
32 // Set field-specific errors from the form!
33 firstName: 'Name already exists',
34 lastName: 'Name already exists',
35 },
36 })
37 },
38 })
39β
40 return (
41 <div>
42 <h1>Simple Form Example</h1>
43 <form
44 onSubmit={(e) => {
45 e.preventDefault()
46 e.stopPropagation()
47 form.handleSubmit()
48 }}
49 >
50 {/* A type-safe field component*/}
51 <form.Field
52 name="firstName"
53 validators={[
54 {
55 run: ({ value }) => {
56 if (value.length === 0) return 'A first name is required'
57 if (value.length < 3) return 'First name is too short'
58 },
59 // Define what should trigger validation. Submissions trigger validation by default.
60 triggers: ['change', 'blur'],
61 triggerDebounceMs: 300,
62 },
63 {
64 // Supports async functions!
65 run: async ({ value }) => {
66 await new Promise((resolve) => setTimeout(resolve, 1000))
67 return (
68 value.toLowerCase().includes('error') &&
69 'No "error" allowed in first name'
70 )
71 },
72 triggers: ['change'],
73 // prevent expensive validators from running
74 bailIfInvalid: true,
75 },
76 ]}
77 >
78 {(field) => {
79 // Avoid hasty abstractions. Render props are great!
80 return (
81 <label className={field.meta.isValidating ? 'validating' : ''}>
82 <span>First Name</span>
83β
84 <input
85 name={field.name}
86 value={field.value}
87 onBlur={field.handleBlur}
88 onChange={(e) => field.handleChange(e.target.value)}
89 aria-invalid={field.meta.isInvalid}
90 />
91 <FieldError field={field} />
92 </label>
93 )
94 }}
95 </form.Field>
96 <form.Field name="lastName">
97 {(field) => (
98 <label className={field.meta.isValidating ? 'validating' : ''}>
99 <span>Last Name</span>
100 <input
101 name={field.name}
102 value={field.value}
103 onBlur={field.handleBlur}
104 onChange={(e) => field.handleChange(e.target.value)}
105 aria-invalid={field.meta.isInvalid}
106 />
107 <FieldError field={field} />
108 </label>
109 )}
110 </form.Field>
111 {/** Subscribe to form state to have reactive components */}
112 <form.Subscribe
113 selector={(state) => [state.canSubmit, state.isSubmitting]}
114 >
115 {([canSubmit, isSubmitting]) => (
116 <button type="submit" disabled={!canSubmit || isSubmitting}>
117 {isSubmitting ? '...' : 'Submit'}
118 </button>
119 )}
120 </form.Subscribe>
121 <button
122 type="reset"
123 onClick={(e) => {
124 // Avoid unexpected resets of form elements (especially <select> elements)
125 e.preventDefault()
126 form.reset()
127 }}
128 >
129 Reset
130 </button>
131 </form>
132 <TanStackDevtools
133 plugins={[formDevtoolsPlugin()]}
134 config={{
135 hideUntilHover: false,
136 }}
137 />
138 </div>
139 )
140}
141β
142ReactDOM.createRoot(document.getElementById('root')!).render(<App />)