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